Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

FX::FXAccelTable Class Reference

The accelerator table sends a message to a specific target object when the indicated key and modifier combination is pressed. More...

#include <FXAccelTable.h>

Inheritance diagram for FX::FXAccelTable:

FX::FXObject List of all members.

Public Member Functions

 FXAccelTable ()
void addAccel (FXHotKey hotkey, FXObject *target=NULL, FXSelector seldn=0, FXSelector selup=0)
void removeAccel (FXHotKey hotkey)
bool hasAccel (FXHotKey hotkey) const
FXObjecttargetOfAccel (FXHotKey hotkey) const
virtual void save (FXStream &store) const
virtual void load (FXStream &store)
virtual ~FXAccelTable ()

Friends

FXHotKey parseAccel (const FXString &string)
FXString unparseAccel (FXHotKey key)
FXHotKey parseHotKey (const FXString &string)
FXint findHotKey (const FXString &string)
FXString stripHotKey (const FXString &string)

Detailed Description

The accelerator table sends a message to a specific target object when the indicated key and modifier combination is pressed.


Constructor & Destructor Documentation

FX::FXAccelTable::FXAccelTable  ) 
 

Construct empty accelerator table.

virtual FX::FXAccelTable::~FXAccelTable  )  [virtual]
 

Destructor.


Member Function Documentation

void FX::FXAccelTable::addAccel FXHotKey  hotkey,
FXObject target = NULL,
FXSelector  seldn = 0,
FXSelector  selup = 0
 

Add an accelerator into the table.

void FX::FXAccelTable::removeAccel FXHotKey  hotkey  ) 
 

Remove an accelerator from the table.

bool FX::FXAccelTable::hasAccel FXHotKey  hotkey  )  const
 

Return true if accelerator specified.

FXObject* FX::FXAccelTable::targetOfAccel FXHotKey  hotkey  )  const
 

Return target object of the given accelerator.

virtual void FX::FXAccelTable::save FXStream store  )  const [virtual]
 

Save table to a stream.

Reimplemented from FX::FXObject.

virtual void FX::FXAccelTable::load FXStream store  )  [virtual]
 

Load table from a stream.

Reimplemented from FX::FXObject.


Friends And Related Function Documentation

FXHotKey parseAccel const FXString string  )  [friend]
 

Parse accelerator from string, yielding modifier and key code.

For example, parseAccel("Ctl+Shift+X") yields MKUINT(KEY_X,CONTROLMASK|SHIFTMASK).

FXString unparseAccel FXHotKey  key  )  [friend]
 

Unparse hot key comprising modifier and key code back into a string suitable for parsing with fxparseHotKey.

FXHotKey parseHotKey const FXString string  )  [friend]
 

Parse hot key from string, yielding modifier and key code.

For example, parseHotKey(""Salt && &Pepper!"") yields MKUINT(KEY_p,ALTMASK).

FXint findHotKey const FXString string  )  [friend]
 

Obtain hot key offset in string, or -1 if not found.

For example, findHotKey("Salt && &Pepper!") yields 7. Note that this is the byte-offset, not the character index!

FXString stripHotKey const FXString string  )  [friend]
 

Strip hot key combination from the string.

For example, stripHotKey("Salt && &Pepper") should yield "Salt & Pepper".

Copyright © 1997-2005 Jeroen van der Zijp