Planeshift
Public Member Functions | Protected Member Functions | Protected Attributes

pawsShortcutWindow Class Reference

The shortcut window itself. More...

#include <shortcutwindow.h>

List of all members.

Public Member Functions

void ExecuteCommand (int shortcutNum)
 Execute a short cut script.
const csString & GetCommandName (int shortcutNum)
 Get the short cut script.
char const * GetFontName ()
 return the name of the font
float GetHPDangerLevel ()
float GetHPFlashLevel ()
float GetHPWarnLevel ()
float GetManaDangerLevel ()
float GetManaFlashLevel ()
float GetManaWarnLevel ()
int GetMonitorState ()
csString GetTriggerText (int shortcutNum)
 Get the text of a buttons assigned shortcut key.
void LoadCommands (const char *FN)
void LoadCommandsFile ()
void LoadDefaultCommands ()
 Load the commands, icon names and shortcut text keys.
bool LoadUserPrefs ()
 Load the preferences set by the Shortcut Configuration interface.
bool LoadUserSharedPrefs ()
bool OnButtonPressed (int mouseButton, int keyModifier, pawsWidget *reporter)
 Called whenever a button is pressed.
bool OnButtonReleased (int mouseButton, int keyModifier, pawsWidget *reporter)
 Called whenever a button is released.
bool OnFingering (csString string, psControl::Device device, uint button, uint32 mods)
 Returns whether the combo was accepted and the fingering window should hide.
bool OnMouseDown (int button, int modifiers, int x, int y)
 Manage mouse down event to test for and apply window changes.
void OnResize ()
 Sets the new position of the close button.
bool OnScroll (int direction, pawsScrollBar *widget)
 Called whenever a window is scrolled.
 pawsShortcutWindow ()
virtual bool PostSetup ()
 This is called after the widget and all of it's children have been created.
void ResetEditWindow ()
void SaveCommands ()
void SaveCommands (const char *FN)
void SetHPDangerLevel (float val)
void SetHPFlashLevel (float val)
void SetHPOn (bool val)
void SetHPWarnLevel (float val)
void SetManaDangerLevel (float val)
void SetManaFlashLevel (float val)
void SetManaOn (bool val)
void SetManaWarnLevel (float val)
virtual bool Setup (iDocumentNode *node)
 Setup this widget.
void Show ()
 When the window is opened let the controller window know about it.
void StartMonitors ()
void StopMonitors ()
virtual ~pawsShortcutWindow ()

Protected Member Functions

virtual void HandleMessage (MsgEntry *msg)

Protected Attributes

csString buttonBackgroundImage
pawsChatWindowchatWindow
 chat window for easy access
csArray< csString > cmds
CmdHandlercmdsource
size_t edit
pawsWidgeteditedButton
csArray< csString > icon
pawsDnDButtoniconDisplay
int iconDisplayID
pawsScrollMenuiconPalette
pawsEditTextBoxlabelBox
csArray< csString > names
pawsTextBoxshortcutText
pawsWidgetsubWidget
pawsMultilineEditTextBoxtextBox
pawsTextBoxtitle
csArray< csString > toolTips
csRef< iVFS > vfs

Detailed Description

The shortcut window itself.

Definition at line 62 of file shortcutwindow.h.


Constructor & Destructor Documentation

pawsShortcutWindow::pawsShortcutWindow ( )
virtual pawsShortcutWindow::~pawsShortcutWindow ( ) [virtual]

Member Function Documentation

void pawsShortcutWindow::ExecuteCommand ( int  shortcutNum)

Execute a short cut script.

Parameters:
shortcutNumis the button ordinal number
const csString& pawsShortcutWindow::GetCommandName ( int  shortcutNum)

Get the short cut script.

Parameters:
shortcutNumis the button ordinal number
char const* pawsShortcutWindow::GetFontName ( ) [inline]

return the name of the font

Definition at line 120 of file shortcutwindow.h.

float pawsShortcutWindow::GetHPDangerLevel ( )
float pawsShortcutWindow::GetHPFlashLevel ( )
float pawsShortcutWindow::GetHPWarnLevel ( )
float pawsShortcutWindow::GetManaDangerLevel ( )
float pawsShortcutWindow::GetManaFlashLevel ( )
float pawsShortcutWindow::GetManaWarnLevel ( )
int pawsShortcutWindow::GetMonitorState ( )
csString pawsShortcutWindow::GetTriggerText ( int  shortcutNum)

Get the text of a buttons assigned shortcut key.

Parameters:
shortcutNumis the button ordinal number
virtual void pawsShortcutWindow::HandleMessage ( MsgEntry msg) [protected, virtual]

Implements psClientNetSubscriber.

void pawsShortcutWindow::LoadCommands ( const char *  FN)
void pawsShortcutWindow::LoadCommandsFile ( )
void pawsShortcutWindow::LoadDefaultCommands ( )

Load the commands, icon names and shortcut text keys.

bool pawsShortcutWindow::LoadUserPrefs ( )

Load the preferences set by the Shortcut Configuration interface.

bool pawsShortcutWindow::LoadUserSharedPrefs ( )
bool pawsShortcutWindow::OnButtonPressed ( int  button,
int  keyModifier,
pawsWidget widget 
) [virtual]

Called whenever a button is pressed.

Parameters:
buttonThe button pressed.
keyModifierModifier key in effect.
widgetThe widget the button belongs to.
Returns:
bool Parent's result or FALSE if no parent.

Reimplemented from pawsWidget.

bool pawsShortcutWindow::OnButtonReleased ( int  button,
int  keyModifier,
pawsWidget widget 
) [virtual]

Called whenever a button is released.

Parameters:
buttonThe button released.
keyModifierModifier key in effect.
widgetThe widget the button belongs to.
Returns:
bool Parent's result or FALSE if no parent.

Reimplemented from pawsWidget.

bool pawsShortcutWindow::OnFingering ( csString  string,
psControl::Device  device,
uint  button,
uint32  mods 
) [virtual]

Returns whether the combo was accepted and the fingering window should hide.

Implements pawsFingeringReceiver.

bool pawsShortcutWindow::OnMouseDown ( int  button,
int  modifiers,
int  x,
int  y 
) [virtual]

Manage mouse down event to test for and apply window changes.

Parameters:
buttonType of button: 1 resizable or movable, 2 context menu or config window.
modifiersUsed with PAWS_CONSTRUCTION.
xUsed to test for resize.
yUsed to test for resize.
Returns:
bool TRUE if movable or resizable.
Remarks:
calls OnMouseDown on it's parent.

Reimplemented from pawsWidget.

void pawsShortcutWindow::OnResize ( ) [virtual]

Sets the new position of the close button.

Reimplemented from pawsWidget.

bool pawsShortcutWindow::OnScroll ( int  scrollDirection,
pawsScrollBar widget 
) [virtual]

Called whenever a window is scrolled.

Parameters:
scrollDirectionThe direction to move.
widgetThe scrollbar widget being manipulated.
Returns:
bool Parent's result or FALSE if no parent.

Reimplemented from pawsWidget.

virtual bool pawsShortcutWindow::PostSetup ( ) [virtual]

This is called after the widget and all of it's children have been created.

Remarks:
This can be useful for widgets that want to get pointers to some of it's children for quick access.

Reimplemented from pawsWidget.

void pawsShortcutWindow::ResetEditWindow ( )
void pawsShortcutWindow::SaveCommands ( const char *  FN)
void pawsShortcutWindow::SaveCommands ( )
void pawsShortcutWindow::SetHPDangerLevel ( float  val)
void pawsShortcutWindow::SetHPFlashLevel ( float  val)
void pawsShortcutWindow::SetHPOn ( bool  val)
void pawsShortcutWindow::SetHPWarnLevel ( float  val)
void pawsShortcutWindow::SetManaDangerLevel ( float  val)
void pawsShortcutWindow::SetManaFlashLevel ( float  val)
void pawsShortcutWindow::SetManaOn ( bool  val)
void pawsShortcutWindow::SetManaWarnLevel ( float  val)
virtual bool pawsShortcutWindow::Setup ( iDocumentNode *  ) [virtual]

Setup this widget.

Reimplemented from pawsWidget.

void pawsShortcutWindow::Show ( void  ) [virtual]

When the window is opened let the controller window know about it.

Reimplemented from pawsControlledWindow.

void pawsShortcutWindow::StartMonitors ( )
void pawsShortcutWindow::StopMonitors ( )

Member Data Documentation

Definition at line 182 of file shortcutwindow.h.

chat window for easy access

Definition at line 154 of file shortcutwindow.h.

csArray<csString> pawsShortcutWindow::cmds [protected]

Definition at line 157 of file shortcutwindow.h.

Definition at line 155 of file shortcutwindow.h.

size_t pawsShortcutWindow::edit [protected]

Definition at line 184 of file shortcutwindow.h.

Definition at line 185 of file shortcutwindow.h.

csArray<csString> pawsShortcutWindow::icon [protected]

Definition at line 160 of file shortcutwindow.h.

Definition at line 179 of file shortcutwindow.h.

Definition at line 180 of file shortcutwindow.h.

Definition at line 178 of file shortcutwindow.h.

Definition at line 168 of file shortcutwindow.h.

csArray<csString> pawsShortcutWindow::names [protected]

Definition at line 158 of file shortcutwindow.h.

Definition at line 171 of file shortcutwindow.h.

Definition at line 176 of file shortcutwindow.h.

Definition at line 165 of file shortcutwindow.h.

Definition at line 173 of file shortcutwindow.h.

csArray<csString> pawsShortcutWindow::toolTips [protected]

Definition at line 159 of file shortcutwindow.h.

csRef<iVFS> pawsShortcutWindow::vfs [protected]

Definition at line 162 of file shortcutwindow.h.


The documentation for this class was generated from the following file: