vgui_function_tableau Class Reference

#include <vgui_function_tableau.h>

Inheritance diagram for vgui_function_tableau:

Inheritance graph
[legend]

List of all members.


Detailed Description

Tableau where functions passed in are called for various events.

For example, you can pass in my_draw_function() to draw() and it will be called every time a draw event occurs in this tableau.

Definition at line 31 of file vgui_function_tableau.h.


Public Types

typedef bool(* function )(const vgui_event &)

Public Member Functions

 vgui_function_tableau ()
 Constructor - don't use this, use vgui_function_tableau_new.
vcl_string type_name () const
 Returns the type of this tableau ('vgui_function_tableau').
void draw (function f)
 Call the given function when a draw event occurs.
virtual bool draw ()
 Called by default handle when it receives a draw event.
void mouse_up (function f)
 Call the given function when a mouse up event occurs.
virtual bool mouse_up (int x, int y, vgui_button, vgui_modifier)
 Called by default handle when it receives a mouse up event.
void mouse_down (function f)
 Call the given function when a mouse down event occurs.
virtual bool mouse_down (int x, int y, vgui_button, vgui_modifier)
 Called by default handle when it receives a mouse down event.
void motion (function f)
 Call the given function when a mouse motion event occurs.
virtual bool motion (int x, int y)
 Called by handle when it receives a mouse motion event.
void key_press (function f)
 Call the given function when a key is pressed by the user.
virtual bool key_press (int x, int y, vgui_key, vgui_modifier)
 Called by default handle when it receives a key-press event.
void help (function f)
 Call the given function when the '?' or 'help' key is pressed by the user.
virtual bool help ()
 Called by default handle when it receives a '?' pressed event.
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.
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 a overlay-redraw event.
virtual void post_idle_request ()
 Post an idle request event.
virtual bool get_bounding_box (float low[3], float high[3]) const
 Get the bounding box of this tableau.
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.

Static Public Attributes

static vgui_DLLDATA bool redraw = false

Protected Member Functions

 ~vgui_function_tableau ()
 Destructor - called by vgui_function_tableau_sptr.
bool handle (const vgui_event &)
 Handle all events by passing them to the appropriate functions.

Protected Attributes

function draw_
function mouse_up_
function mouse_down_
function motion_
function key_press_
function help_

Member Typedef Documentation

typedef bool(* vgui_function_tableau::function)(const vgui_event &)


Constructor & Destructor Documentation

vgui_function_tableau::vgui_function_tableau (  ) 

Constructor - don't use this, use vgui_function_tableau_new.

Creates a default vgui_function tableau.

Creates a default vgui_function_tableau.

Definition at line 17 of file vgui_function_tableau.cxx.

vgui_function_tableau::~vgui_function_tableau (  )  [protected]

Destructor - called by vgui_function_tableau_sptr.

Definition at line 29 of file vgui_function_tableau.cxx.


Member Function Documentation

vcl_string vgui_function_tableau::type_name (  )  const [inline, virtual]

Returns the type of this tableau ('vgui_function_tableau').

Reimplemented from vgui_tableau.

Definition at line 41 of file vgui_function_tableau.h.

void vgui_function_tableau::draw ( function  f  )  [inline]

Call the given function when a draw event occurs.

Definition at line 44 of file vgui_function_tableau.h.

bool vgui_function_tableau::draw (  )  [virtual]

Called by default handle when it receives a draw event.

Reimplemented from vgui_tableau.

Definition at line 87 of file vgui_function_tableau.cxx.

void vgui_function_tableau::mouse_up ( function  f  )  [inline]

Call the given function when a mouse up event occurs.

Definition at line 48 of file vgui_function_tableau.h.

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

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

Reimplemented from vgui_tableau.

Definition at line 93 of file vgui_function_tableau.cxx.

void vgui_function_tableau::mouse_down ( function  f  )  [inline]

Call the given function when a mouse down event occurs.

Definition at line 52 of file vgui_function_tableau.h.

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

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

Reimplemented from vgui_tableau.

Definition at line 101 of file vgui_function_tableau.cxx.

void vgui_function_tableau::motion ( function  f  )  [inline]

Call the given function when a mouse motion event occurs.

Definition at line 56 of file vgui_function_tableau.h.

bool vgui_function_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 from vgui_tableau.

Definition at line 109 of file vgui_function_tableau.cxx.

void vgui_function_tableau::key_press ( function  f  )  [inline]

Call the given function when a key is pressed by the user.

Definition at line 60 of file vgui_function_tableau.h.

bool vgui_function_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 from vgui_tableau.

Definition at line 117 of file vgui_function_tableau.cxx.

void vgui_function_tableau::help ( function  f  )  [inline]

Call the given function when the '?' or 'help' key is pressed by the user.

Definition at line 64 of file vgui_function_tableau.h.

bool vgui_function_tableau::help (  )  [virtual]

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

Reimplemented from vgui_tableau.

Definition at line 125 of file vgui_function_tableau.cxx.

bool vgui_function_tableau::handle ( const vgui_event event  )  [protected, virtual]

Handle all events by passing them to the appropriate functions.

Handles all events by passing them to the appropriate functions.

Reimplemented from vgui_tableau.

Definition at line 37 of file vgui_function_tableau.cxx.

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

Return the name of the tableau.

Reimplemented in vgui_easy2D_tableau.

Definition at line 90 of file vgui_tableau.h.

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

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

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

Definition at line 93 of file vgui_tableau.h.

virtual vcl_string vgui_tableau::pretty_name (  )  const [inline, virtual, inherited]

Used to provide an informative name for printouts, debugging etc.

Often it's type_name() + some representation of the essential state.

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

Definition at line 97 of file vgui_tableau.h.

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

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_children ( vcl_vector< vgui_tableau_sptr > *  out  )  const [inherited]

Get the child tableaux for this tableau.

Push children onto the given vcl_vector.

Definition at line 267 of file vgui_tableau.cxx.

vgui_tableau_sptr vgui_tableau::get_child ( unsigned  i  )  const [inherited]

Get the ith child or return 0.

Get the ith child, or return 0.

Definition at line 274 of file vgui_tableau.cxx.

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

Add the given tableau to the list of child tableaux.

Virtual overridden by consenting parents.

Reimplemented in vgui_composite_tableau, vgui_deck_tableau, and vgui_wrapper_tableau.

Definition at line 284 of file vgui_tableau.cxx.

bool vgui_tableau::remove_child ( vgui_tableau_sptr const &   )  [virtual, inherited]

Remove the given child from the list of child tableaux.

Remove the given tableau from the list of child tableaux.

Reimplemented in vgui_composite_tableau, vgui_deck_tableau, and vgui_wrapper_tableau.

Definition at line 291 of file vgui_tableau.cxx.

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

Push all tableaux onto the given vector.

Definition at line 376 of file vgui_tableau.cxx.

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

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

Definition at line 385 of file vgui_tableau.cxx.

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

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::add_popup ( vgui_menu  )  [virtual, inherited]

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_active_tableau, vgui_clear_tableau, and vgui_satellite_tableau_t< object, data >.

Definition at line 316 of file vgui_tableau.cxx.

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

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_deck_tableau, vgui_image_tableau, vgui_poly_tableau, vgui_shell_tableau, vgui_tview_launcher_tableau, and vgui_tview_tableau.

Definition at line 327 of file vgui_tableau.cxx.

void vgui_tableau::post_message ( char const *  msg,
void const *  data 
) [virtual, inherited]

Post a message event.

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

Reimplemented in vgui_adaptor_tableau.

Definition at line 205 of file vgui_tableau.cxx.

void vgui_tableau::post_redraw ( void   )  [virtual, inherited]

Post a draw event.

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

Reimplemented in vgui_adaptor_tableau.

Definition at line 215 of file vgui_tableau.cxx.

void vgui_tableau::post_overlay_redraw ( void   )  [virtual, inherited]

Post a overlay-redraw event.

Post a overlay redraw event.

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

Reimplemented in vgui_adaptor_tableau.

Definition at line 225 of file vgui_tableau.cxx.

void vgui_tableau::post_idle_request ( void   )  [virtual, inherited]

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.

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

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_image_tableau, vgui_roi_tableau, and vgui_wrapper_tableau.

Definition at line 198 of file vgui_tableau.cxx.

bool vgui_tableau::idle (  )  [virtual, inherited]

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.

void vgui_tableau::ref (  )  const [inherited]

Increase the reference count by one (for smart pointers).

Increase the reference count by one (for smart-pointers).

"const" is for convenience, it is cast away internally.

Definition at line 79 of file vgui_tableau.cxx.

void vgui_tableau::unref (  )  const [inherited]

Decrease the reference count by one (for smart pointers).

Decrease the reference count by one (for smart-pointers).

"const" is for convenience, it is cast away internally. If the reference count reaches zero then delete the object.

If the reference count reaches zero then delete the object.

Definition at line 87 of file vgui_tableau.cxx.


Member Data Documentation

bool vgui_function_tableau::redraw = false [static]

Definition at line 67 of file vgui_function_tableau.h.

Definition at line 76 of file vgui_function_tableau.h.

Definition at line 77 of file vgui_function_tableau.h.

Definition at line 78 of file vgui_function_tableau.h.

Definition at line 79 of file vgui_function_tableau.h.

Definition at line 80 of file vgui_function_tableau.h.

Definition at line 81 of file vgui_function_tableau.h.


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

Generated on Sun Nov 22 06:22:00 2009 for core/vgui by  doxygen 1.5.5