Base class for all tableaux in vgui. More...

#include <vgui_tableau.h>

Inheritance diagram for vgui_tableau:

Public Member Functions
	vgui_tableau ()
	Constructor - in general you should not use this, use vgui_tableau_new.
virtual vcl_string	name () const
	Return the name of the tableau.
virtual vcl_string	file_name () const
	Return the name of a file associated with some tableau below (if meaningful).
virtual vcl_string	pretty_name () const
	Used to provide an informative name for printouts, debugging etc.
virtual vcl_string	type_name () const
	Return name of most derived class (for RTTI purposes).
void	get_parents (vcl_vector< vgui_tableau_sptr > *out) const
	Get the parent tableaux for this tableau.
void	get_children (vcl_vector< vgui_tableau_sptr > *out) const
	Get the child tableaux for this tableau.
vgui_tableau_sptr	get_child (unsigned i) const
	Get the ith child or return 0.
virtual bool	add_child (vgui_tableau_sptr const &)
	Add the given tableau to the list of child tableaux.
virtual bool	remove_child (vgui_tableau_sptr const &)
	Remove the given child from the list of child tableaux.
virtual bool	notify_replaced_child (vgui_tableau_sptr const &old_child, vgui_tableau_sptr const &new_child)
	Called whenever a child of this tableau is about to be forcibly replaced.
virtual void	add_popup (vgui_menu &)
	Add the given menu to the popup menu for the tableau.
virtual void	get_popup (vgui_popup_params const &, vgui_menu &)
	Get the default popup menu for the tableau.
virtual void	post_message (char const , void const )
	Post a message event.
virtual void	post_redraw ()
	Post a draw event.
virtual void	post_overlay_redraw ()
	Post an overlay-redraw event.
virtual void	post_idle_request ()
	Post an idle request event.
virtual bool	handle (vgui_event const &)
	Handle all events sent to this tableau.
virtual bool	get_bounding_box (float low[3], float high[3]) const
	Get the bounding box of this tableau.
virtual bool	draw ()
	Called by default handle when it receives a draw event.
virtual bool	mouse_down (int x, int y, vgui_button, vgui_modifier)
	Called by default handle when it receives a mouse down event.
virtual bool	mouse_up (int x, int y, vgui_button, vgui_modifier)
	Called by default handle when it receives a mouse up event.
virtual bool	motion (int x, int y)
	Called by handle when it receives a mouse motion event.
virtual bool	key_press (int x, int y, vgui_key, vgui_modifier)
	Called by default handle when it receives a key-press event.
virtual bool	help ()
	Called by default handle when it receives a '?' pressed event.
virtual bool	idle ()
	Called when the application is otherwise idle.
void	ref () const
	Increase the reference count by one (for smart pointers).
void	unref () const
	Decrease the reference count by one (for smart pointers).
Static Public Member Functions
static void	get_all (vcl_vector< vgui_tableau_sptr > *out)
	Push all tableaux onto the given vector.
static bool	exists (vgui_tableau_sptr const &)
	Returns true if the given address points to a valid tableau.
Protected Member Functions
virtual	~vgui_tableau ()
	Destructor - called by vgui_tableau_sptr.
Private Attributes
int	references
	Reference count - starts at 0.
Friends
struct	vgui_parent_child_link
struct	vgui_parent_child_link_impl
class	vgui_adaptor

Detailed Description

Base class for all tableaux in vgui.

WHAT'S A TABLEAU? A tableau is a rectangular area of the screen on which OpenGL may be used to draw and from which events (mouse, key presses etc) are received.

WHAT SORT OF THINGS CAN TABLEAUX DO? Currently VGUI provides several example tableaux derived from this class, sufficient to construct complex user interfaces combining 2D and 3D with manipulators and zoom. So for example an `image' tableau could display an image, a `zoomer' tableau could provide a function to zoom an image in and out. We could also make a `deck' tableau to hold a deck of images and display one image at a time (this would be useful for playing a series of images as a movie).

WHAT ARE PARENT AND CHILD TABLEAUX? One tableau can be included as a child of another (parent) tableau. This creates a new tableau with the functionality of both tableaux making it up. So the new tableau could, for example, display a deck of images and provide zooming.

The order in which the inclusion is done will affect the functionality, so if the `zoomer' tableau contains the `deck' tableau then all images will change size together. If however the inclusion is done the other way around and each child tableau of the `deck' contains its own `zoomer' tableau then each image will change size independently.

WHAT'S ALL THIS SPTR BUSINESS THEN? When you make a new tableau it is recommended that you don't create it from the constructor for that tableau (eg, vgui_wibble_tableau()), but instead call vgui_wibble_tableau_new(). This returns a smart pointer to your tableau (vgui_wibble_tableau_sptr) and means that you don't need to worry about deleting your tableau once you are finished using it.

SO HOW DO I USE A TABLEAU? Once-off adaptor code (see vgui_adaptor) is provided that plugs a tableau into any supported GUI toolkit. So to use a tableau you make a window, add an adaptor and set the tableau in that adaptor to be your top level (highest parent) tableau. See the examples on the VXL webpage to see this done.

Definition at line 83 of file vgui_tableau.h.

Constructor & Destructor Documentation

vgui_tableau::vgui_tableau ( )

Constructor - in general you should not use this, use vgui_tableau_new.

Constructor.

Don't use the constructor for a tableau, use vgui_tableau_sptr to get a smart-pointer to your tableau.

Definition at line 41 of file vgui_tableau.cxx.

vgui_tableau::~vgui_tableau ( ) [protected, virtual]

Destructor - called by vgui_tableau_sptr.

Destructor - called by vgui_tableau_sptr when ref count is zero.

Definition at line 56 of file vgui_tableau.cxx.

Member Function Documentation

bool vgui_tableau::add_child ( vgui_tableau_sptr const & ) [virtual]

Add the given tableau to the list of child tableaux.

Virtual overridden by consenting parents.

Reimplemented in vgui_composite_tableau, vgui_selector_tableau, vgui_deck_tableau, and vgui_wrapper_tableau.

Definition at line 284 of file vgui_tableau.cxx.

void vgui_tableau::add_popup ( vgui_menu & ) [virtual]

Add the given menu to the popup menu for the tableau.

Add given menu to the tableau popup menu.

This method is for tableaux to implement if they want to _add_ some items to the popup menu. They can assign to or clear 'menu', but that is not recommended as it would remove what other tableaux put there. The recommended usage is to .add() items or to .include() another menu.

** This is an interface method. it abstracts a behaviour. **

Reimplemented in vgui_satellite_tableau_t< object, data >, vgui_active_tableau, and vgui_clear_tableau.

Definition at line 316 of file vgui_tableau.cxx.

bool vgui_tableau::draw ( ) [virtual]

Called by default handle when it receives a draw event.

Reimplemented in vgui_function_tableau.

Definition at line 176 of file vgui_tableau.cxx.

bool vgui_tableau::exists ( vgui_tableau_sptr const & ptr ) [static]

Returns true if the given address points to a valid tableau.

Definition at line 385 of file vgui_tableau.cxx.

virtual vcl_string vgui_tableau::file_name ( ) const [inline, virtual]

Return the name of a file associated with some tableau below (if meaningful).

Reimplemented in vgui_easy2D_tableau, vgui_deck_tableau, vgui_composite_tableau, vgui_blender_tableau, vgui_roi_tableau, vgui_enhance_tableau, vgui_selector_tableau, vgui_image_tableau, vgui_wrapper_tableau, and vgui_vrml_tableau.

Definition at line 93 of file vgui_tableau.h.

void vgui_tableau::get_all ( vcl_vector< vgui_tableau_sptr > * out ) [static]

Push all tableaux onto the given vector.

Definition at line 376 of file vgui_tableau.cxx.

bool vgui_tableau::get_bounding_box	(	float	low[3],
		float	high[3]
	)		const `[virtual]`

Get the bounding box of this tableau.

Return the bounding box of this tableau.

If infinite in extent, or nothing is drawn, or you can't be bothered to implement it, return false. const. if you need to cache, cast away const.

If infinite in extent, or nothing is drawn, or you can't be bothered to implement it, return false.

Reimplemented in vgui_composite_tableau, vgui_selector_tableau, vgui_image_tableau, vgui_roi_tableau, and vgui_wrapper_tableau.

Definition at line 198 of file vgui_tableau.cxx.

vgui_tableau_sptr vgui_tableau::get_child ( unsigned i ) const

Get the ith child or return 0.

Get the ith child, or return 0.

Definition at line 274 of file vgui_tableau.cxx.

void vgui_tableau::get_children ( vcl_vector< vgui_tableau_sptr > * out ) const

Get the child tableaux for this tableau.

Push children onto the given vcl_vector.

Definition at line 267 of file vgui_tableau.cxx.

void vgui_tableau::get_parents ( vcl_vector< vgui_tableau_sptr > * out ) const

Get the parent tableaux for this tableau.

Push parents onto the given vcl_vector.

Definition at line 260 of file vgui_tableau.cxx.

void vgui_tableau::get_popup	(	vgui_popup_params const &	params,
		vgui_menu &	menu
	)		`[virtual]`

Get the default popup menu for the tableau.

Gets popup menu for this tableau.

If recurse is, true, recursively add the popup menus for children and children's children etc.

** this is a mixin method. it does some work for you. **

Reimplemented in vgui_image_tableau, vgui_shell_tableau, vgui_deck_tableau, vgui_poly_tableau, vgui_selector_tableau, vgui_tview_launcher_tableau, and vgui_tview_tableau.

Definition at line 327 of file vgui_tableau.cxx.

bool vgui_tableau::handle ( vgui_event const & event ) [virtual]

Handle all events sent to this tableau.

Override in subclass to give the tableau some appearance and behaviour.

Override in subclasses to give the tableau some appearance and behaviour.

Reimplemented in vgui_grid_tableau, vgui_rubberband_tableau, vgui_poly_tableau, vgui_satellite_tableau< object >, vgui_image_tableau, vgui_shell_tableau, vgui_satellite_tableau_t< object, data >, vgui_deck_tableau, vgui_slider_tableau, vgui_roi_tableau, vgui_text_tableau, vgui_loader_tableau, vgui_easy2D_tableau, vgui_displaybase_tableau, vgui_function_tableau, vgui_listmanager2D_tableau, vgui_composite_tableau, vgui_enhance_tableau, vgui_blender_tableau, vgui_clear_tableau, vgui_wrapper_tableau, vgui_active_tableau, vgui_blackbox_tableau, vgui_selector_tableau, vgui_debug_tableau, vgui_drag_tableau, vgui_tview_launcher_tableau, vgui_viewer2D_tableau, vgui_viewer3D_tableau, vgui_vrml_tableau, vgui_displaylist3D_tableau, vgui_tview_tableau, vgui_adaptor_tableau, vgui_displaylist2D_tableau, vgui_event_server_interpose_tableau, and vgui_quit_tableau.

Definition at line 99 of file vgui_tableau.cxx.

bool vgui_tableau::help ( ) [virtual]

Called by default handle when it receives a '?' pressed event.

Reimplemented in vgui_deck_tableau, vgui_listmanager2D_tableau, vgui_composite_tableau, vgui_viewer2D_tableau, vgui_function_tableau, and vgui_viewer3D_tableau.

Definition at line 166 of file vgui_tableau.cxx.

bool vgui_tableau::idle ( ) [virtual]

Called when the application is otherwise idle.

Override if you want to do idle processing. Return false once your idle processing is complete, or if you have no need for more idle processing. Return true if you need more idle processing time.

Definition at line 185 of file vgui_tableau.cxx.

bool vgui_tableau::key_press	(	int	x,
		int	y,
		vgui_key	,
		vgui_modifier
	)		`[virtual]`

Called by default handle when it receives a key-press event.

Caled by default handle when it receives a key press event.

Reimplemented in vgui_deck_tableau, vgui_listmanager2D_tableau, vgui_viewer2D_tableau, vgui_function_tableau, and vgui_viewer3D_tableau.

Definition at line 156 of file vgui_tableau.cxx.

bool vgui_tableau::motion	(	int	x,
		int	y
	)		`[virtual]`

Called by handle when it receives a mouse motion event.

Called by default handle when it receives a mouse motion event.

Reimplemented in vgui_listmanager2D_tableau, vgui_function_tableau, and vgui_displaylist2D_tableau.

Definition at line 146 of file vgui_tableau.cxx.

bool vgui_tableau::mouse_down	(	int	x,
		int	y,
		vgui_button	,
		vgui_modifier
	)		`[virtual]`

Called by default handle when it receives a mouse down event.

Reimplemented in vgui_listmanager2D_tableau, vgui_viewer2D_tableau, vgui_function_tableau, vgui_viewer3D_tableau, vgui_displaylist3D_tableau, and vgui_displaylist2D_tableau.

Definition at line 126 of file vgui_tableau.cxx.

bool vgui_tableau::mouse_up	(	int	x,
		int	y,
		vgui_button	,
		vgui_modifier
	)		`[virtual]`

Called by default handle when it receives a mouse up event.

Reimplemented in vgui_viewer2D_tableau, vgui_function_tableau, and vgui_viewer3D_tableau.

Definition at line 136 of file vgui_tableau.cxx.

virtual vcl_string vgui_tableau::name ( void ) const [inline, virtual]

Return the name of the tableau.

Reimplemented in vgui_easy2D_tableau.

Definition at line 90 of file vgui_tableau.h.

bool vgui_tableau::notify_replaced_child	(	vgui_tableau_sptr const &	old_child,
		vgui_tableau_sptr const &	new_child
	)		`[virtual]`

Called whenever a child of this tableau is about to be forcibly replaced.

Called when a child of this tableau is forcibly replaced.

This method is called when some part of the program (typically the parent_child_link mechanism) is about to forcibly replace a child of this tableau. The canonical reason to override this is in order to invalidate caches.

Definition at line 302 of file vgui_tableau.cxx.

void vgui_tableau::post_idle_request ( void ) [virtual]

Post an idle request event.

The fact that this is virtual does not imply that you should go and override it.

Posting an idle event request means that your tableau has some idle processing that it'd like to do. This means that your tableau will continue to receive vgui_IDLE events until the event handler returns false (i.e. all idle processing is complete). The idle event handler should return false when it has no idle processing, or has completed its idle processing. It may return true if has only partially completed its idle processing; in this case, it will receive more idle event to allow it to complete processing.

Reimplemented in vgui_adaptor_tableau.

Definition at line 235 of file vgui_tableau.cxx.