Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

SmallButtonHolder Class Reference

Inheritance diagram for SmallButtonHolder:

Inheritance graph
[legend]
List of all members.

Public Member Functions

void Lock ()
void Unlock ()
 SmallButtonHolder (PG_Widget *parent, const PG_Rect &rect)
bool eventMouseMotion (const SDL_MouseMotionEvent *motion)
 Overridable Eventhandler for a SDL_MouseMotionEvent message.
bool eventMouseButtonDown (const SDL_MouseButtonEvent *button)
 Overridable Eventhandler for a SDL_MouseButtonEvent message.
bool eventMouseButtonUp (const SDL_MouseButtonEvent *button)
 Overridable Eventhandler for a SDL_MouseButtonEvent message.
bool ProcessEvent (const SDL_Event *event, bool bModal)
 Process a native PG_ event.
bool ProcessEvent (const SDL_Event *event)
 Sends an event directly to an object.

Constructor & Destructor Documentation

SmallButtonHolder::SmallButtonHolder PG_Widget parent,
const PG_Rect rect
[inline]
 

Definition at line 285 of file guiiconhandler.cpp.


Member Function Documentation

bool SmallButtonHolder::eventMouseButtonDown const SDL_MouseButtonEvent *  button  )  [inline, virtual]
 

Overridable Eventhandler for a SDL_MouseButtonEvent message.

This handler is called when a mouse button is pressed. The default implementation returns 'false' which indicates that this message is not processed by this object.

Parameters:
button SDL_MouseButtonEvent message
Returns:
Notifies the message pump if this message is processed by this object or it should be routed to the next message receiver.

Reimplemented from PG_MessageObject.

Definition at line 287 of file guiiconhandler.cpp.

bool SmallButtonHolder::eventMouseButtonUp const SDL_MouseButtonEvent *  button  )  [inline, virtual]
 

Overridable Eventhandler for a SDL_MouseButtonEvent message.

This handler is called when a mouse button is released. The default implementation returns 'false' which indicates that this message is not processed by this object.

Parameters:
button SDL_MouseButtonEvent message
Returns:
Notifies the message pump if this message is processed by this object or it should be routed to the next message receiver.

Reimplemented from PG_MessageObject.

Definition at line 288 of file guiiconhandler.cpp.

References Unlock().

bool SmallButtonHolder::eventMouseMotion const SDL_MouseMotionEvent *  motion  )  [inline, virtual]
 

Overridable Eventhandler for a SDL_MouseMotionEvent message.

This handler is called when mouse movement is detected. The default implementation returns 'false' which indicates that this message is not processed by this object.

Parameters:
motion SDL_MouseMotionEvent message
Returns:
Notifies the message pump if this message is processed by this object or it should be routed to the next message receiver.

Reimplemented from PG_MessageObject.

Definition at line 286 of file guiiconhandler.cpp.

void SmallButtonHolder::Lock  )  [inline]
 

Definition at line 282 of file guiiconhandler.cpp.

References PG_MessageObject::SetCapture().

Referenced by NewGuiHost::showSmallIcons().

bool SmallButtonHolder::ProcessEvent const SDL_Event *  event  )  [inline, virtual]
 

Sends an event directly to an object.

Parameters:
event SDL_Event message
Returns:
Notifies the message pump if this message is processed by this object or it should be routed to the next message receiver.

Reimplemented from PG_MessageObject.

Definition at line 291 of file guiiconhandler.cpp.

References PG_Widget::ProcessEvent(), PG_MessageObject::ReleaseCapture(), PG_MessageObject::SetCapture(), and Unlock().

bool SmallButtonHolder::ProcessEvent const SDL_Event *  event,
bool  bModal
[inline, virtual]
 

Process a native PG_ event.

Parameters:
event PG_ event to process
bModal set to true if processing takes place in a modal loop
Returns:
true if the event was sucessfully processed
ProcessEvent asks the widget to process a given event. It also asks its parent and, if bModal is true, its children.

Reimplemented from PG_Widget.

Definition at line 290 of file guiiconhandler.cpp.

References PG_Widget::ProcessEvent().

Referenced by NewGuiHost::ProcessEvent().

void SmallButtonHolder::Unlock  )  [inline]
 

Definition at line 283 of file guiiconhandler.cpp.

References PG_MessageObject::ReleaseCapture().

Referenced by NewGuiHost::clearSmallIcons(), eventMouseButtonUp(), and ProcessEvent().


The documentation for this class was generated from the following file:
Generated on Tue Jun 24 02:20:52 2008 for Advanced Strategic Command by  doxygen 1.4.2