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.

void UIObject::command_wanted ( int cmd ) [protected]

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

Definition at line 57 of file UIObject.C.
Referenced by ColorFltkMenu::ColorFltkMenu, DisplayFltkMenu::DisplayFltkMenu, FileChooserFltkMenu::FileChooserFltkMenu, GeometryFltkMenu::GeometryFltkMenu, GraphicsFltkMenu::GraphicsFltkMenu, MainFltkMenu::MainFltkMenu, MaterialFltkMenu::MaterialFltkMenu, RenderFltkMenu::RenderFltkMenu, SaveTrajectoryFltkMenu::SaveTrajectoryFltkMenu, ToolFltkMenu::ToolFltkMenu, UIVR::UIVR, and VMDCollab::VMDCollab.

virtual void UIObject::do_off ( ) [inline, protected, virtual]

Reimplemented in VMDFltkMenu.
Definition at line 67 of file UIObject.h.
Referenced by Off.

virtual void UIObject::do_on ( ) [inline, protected, virtual]

virtual methods for performing on/off actions.

Reimplemented in VMDFltkMenu.
Definition at line 66 of file UIObject.h.
Referenced by On.

void UIObject::Off ( ) [inline]

Definition at line 82 of file UIObject.h.
References do_off.
Referenced by VMDApp::deactivate_uitext_stdin, and VMDApp::menu_show.

void UIObject::On ( ) [inline]

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.

Definition at line 78 of file UIObject.h.
References do_on.
Referenced by VMDApp::activate_menus, VMDApp::menu_show, and VMDApp::VMDinit.

virtual void UIObject::reset ( void ) [inline, protected, virtual]

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

Reimplemented in Mobile.
Definition at line 60 of file UIObject.h.
Referenced by UIVR::UIVR.

void UIObject::runcommand ( Command * ) [protected]

send a command to the command queue.

Definition at line 62 of file UIObject.C.
References cmdQueue, and CommandQueue::runcommand.
Referenced by Mobile::addNewClient, Win32Joystick::check_event, VMDCollab::check_event, VideoStream::check_event, Spaceball::check_event, Mobile::check_event, IMDMgr::check_event, Animation::check_event, Mouse::move_mode, Mobile::move_mode, Mobile::network_port, Mobile::removeClient, ToolFltkMenu::set_offset, and ToolFltkMenu::set_toolrep.

void UIObject::set_callbacks ( int on ) [inline]

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

Definition at line 106 of file UIObject.h.
References make_callbacks.
Referenced by UIVR::act_on_command, and VMDApp::set_mouse_callbacks.

int UIObject::want_command ( int cmd ) [inline]

is the given command one we're interested in?

Definition at line 91 of file UIObject.h.
Referenced by IMDMgr::IMDMgr, and CommandQueue::runcommand.

Member Data Documentation

VMDApp* UIObject::app [protected]

pointer to parent instance of VMD.

Reimplemented in GraphicsFltkMenu.
Definition at line 48 of file UIObject.h.
Referenced by UIText::act_on_command, SaveTrajectoryFltkMenu::act_on_command, RenderFltkMenu::act_on_command, MaterialFltkMenu::act_on_command, GeometryFltkMenu::act_on_command, GeometryFltkMenu::apply_format_to_selected_labels, GeometryFltkMenu::apply_offset_to_selected_labels, Tool::assign_rep, UIText::change_interp, Win32Joystick::check_event, VideoStream::check_event, Spaceball::check_event, Mouse::check_event, Mobile::check_event, ToolFltkMenu::choose_buttons, ToolFltkMenu::choose_feedback, ToolFltkMenu::choose_tracker, ColorFltkMenu::ColorFltkMenu, ToolFltkMenu::create_tool, ToolFltkMenu::delete_tool, SpringTool::do_event, SaveTrajectoryFltkMenu::do_save, Tool::dograb, Tool::getTargetScale, SaveTrajectoryFltkMenu::molchooser_activate_selection, Mouse::Mouse, Mouse::move_mode, Mouse::reset, ToolFltkMenu::reset_device_menus, ToolFltkMenu::reset_tool_list, ToolFltkMenu::select_tool, ToolFltkMenu::select_tool_type, SaveTrajectoryFltkMenu::selectmol, ToolFltkMenu::set_forcescale, ToolFltkMenu::set_positionscale, ToolFltkMenu::set_springscale, ToolFltkMenu::set_toolrep, Tool::target, Tool::tool_location_update, ToolFltkMenu::ToolFltkMenu, Tool::tug, UIObject, Tool::ungrab, ToolFltkMenu::update_replist, ToolFltkMenu::update_toolrep_choosers, and VideoStream::VideoStream.

CommandQueue* UIObject::cmdQueue [protected]

Command Queue to use for new commands.

Definition at line 51 of file UIObject.h.
Referenced by runcommand, UIObject, and ~UIObject.

int UIObject::make_callbacks [protected]

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

Definition at line 63 of file UIObject.h.
Referenced by Mouse::check_event, set_callbacks, Tool::tool_location_update, and UIObject.

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

Generated on Thu Sep 19 02:46:28 2024 for VMD (current) by

UIObject Class Reference

Public Methods

Protected Methods

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation