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

UIObject Class Reference

User Interface Object base class. All user interface modules are derived from this; it provides methods for registering with the command processor and 'signing up' for which commands it is interested in, as well as generating commands and events. More...

#include <UIObject.h>

Inheritance diagram for UIObject:

List of all members.

Public Methods

UIObject (VMDApp *)

constructor. More...

virtual ~UIObject (void)

destructor. More...

void On ()

Turns the object on or off. When off, the check_event method will not be called for the object. act_on_command will be called because many UIObjects still depend on being kept current with VMD state and don't reset themselves when switched on; we should remove this limitation in the future. More...

void Off ()

int active () const

is UIObject active or not. More...

int want_command (int cmd)

is the given command one we're interested in? More...

virtual int check_event ()

check for an event, and queue it if found. Return TRUE if an event was generated. More...

virtual int act_on_command (int, Command *)

update the display due to a command being executed. Return whether any action was taken on this command. Arguments are the command type, command object, and the success of the command (T or F). More...

void set_callbacks (int on)

send callbacks whenever the object moves (on=true) or don't (on=false). More...

Protected Methods

void runcommand (Command *)

send a command to the command queue. More...

void command_wanted (int cmd)

indicate that we are/are not interested in a command. More...

virtual void reset ()

reset the user interface (force update of all info displays). More...

virtual void do_on ()

virtual methods for performing on/off actions. More...

virtual void do_off ()

Protected Attributes

VMDApp * app

pointer to parent instance of VMD. More...

CommandQueue * cmdQueue

Command Queue to use for new commands. More...

int make_callbacks

send callbacks whenever the object moves (true) or don't (false). More...

Detailed Description

Definition at line 36 of file UIObject.h.

Constructor & Destructor Documentation

UIObject::UIObject ( VMDApp * )

constructor.

Definition at line 34 of file UIObject.C.

References app, cmdQueue, VMDApp::commandQueue, make_callbacks, CommandQueue::register_UI, and Command::TOTAL.

UIObject::~UIObject ( void ) [virtual]

destructor.

Definition at line 51 of file UIObject.C.

References cmdQueue, and CommandQueue::unregister_UI.

Member Function Documentation

virtual int UIObject::act_on_command ( int ,

Command *

) [inline, virtual]

update the display due to a command being executed. Return whether any action was taken on this command. Arguments are the command type, command object, and the success of the command (T or F).

Reimplemented in ColorFltkMenu.

Definition at line 103 of file UIObject.h.

Referenced by CommandQueue::runcommand.

int UIObject::active ( ) const [inline]

is UIObject active or not.

Definition at line 88 of file UIObject.h.

Referenced by Mobile::addNewClient, CommandQueue::check_events, and VMDApp::menu_status.

virtual int UIObject::check_event ( void ) [inline, virtual]

check for an event, and queue it if found. Return TRUE if an event was generated.

Reimplemented in Animation.

Definition at line 97 of file UIObject.h.

Referenced by CommandQueue::check_events.