vgui_wrapper_tableau Class Reference

#include <vgui_wrapper_tableau.h>

Inheritance diagram for vgui_wrapper_tableau:

Inheritance graph
[legend]

List of all members.


Detailed Description

Base class tableau for tableau who want only a single child.

Q: So what does a vgui_wrapper_tableau do, then? A: It's a convenient base class for tableaux who want only a single child, providing mixin code for adding and removing children, and handling the popup menu. To pass on an event to (the child of) a slot use return child.handle(e); which will work even if the slot is empty (returns false).

Q: Why does it have such a silly name? A: Because it is a tableau which "wraps" itself around another tableau. "vgui_parent" was too vague and it was needed for something else anyway. I would welcome suggestions for a better name.

Definition at line 29 of file vgui_wrapper_tableau.h.


Public Member Functions

 vgui_wrapper_tableau ()
 Constructor - don't use this, use vgui_wrapper_tableau_new.
 vgui_wrapper_tableau (vgui_tableau_sptr const &)
 Constructor - don't use this, use vgui_wrapper_tableau_new.
bool add_child (vgui_tableau_sptr const &)
 Adds given tableau as child if none exists, else causes error.
bool remove_child (vgui_tableau_sptr const &)
 The child tableau is removed if it is the same as the given tableau.
vcl_string file_name () const
 Returns the child's file_name if it exists.
vcl_string pretty_name () const
 Returns nice version of the name which also includes details of the child.
vcl_string type_name () const
 Returns the type of tableau ('vgui_wrapper_tableau').
bool handle (vgui_event const &)
 Handle all events sent to this tableau.
bool get_bounding_box (float low[3], float high[3]) const
 Get the bounding box for this tableau.
virtual vcl_string name () const
 Return the name of the tableau.
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 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 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.

Public Attributes

vgui_parent_child_link child
 The single child of this tableau.

Protected Member Functions

 ~vgui_wrapper_tableau ()

Constructor & Destructor Documentation

vgui_wrapper_tableau::vgui_wrapper_tableau (  ) 

Constructor - don't use this, use vgui_wrapper_tableau_new.

The child tableau is added later using add_child.

Definition at line 13 of file vgui_wrapper_tableau.cxx.

vgui_wrapper_tableau::vgui_wrapper_tableau ( vgui_tableau_sptr const &  n  ) 

Constructor - don't use this, use vgui_wrapper_tableau_new.

Takes the single child tableau for this tableau.

Definition at line 18 of file vgui_wrapper_tableau.cxx.

vgui_wrapper_tableau::~vgui_wrapper_tableau (  )  [protected]

Definition at line 23 of file vgui_wrapper_tableau.cxx.


Member Function Documentation

bool vgui_wrapper_tableau::add_child ( vgui_tableau_sptr const &  c  )  [virtual]

Adds given tableau as child if none exists, else causes error.

Reimplemented from vgui_tableau.

Definition at line 42 of file vgui_wrapper_tableau.cxx.

bool vgui_wrapper_tableau::remove_child ( vgui_tableau_sptr const &  c  )  [virtual]

The child tableau is removed if it is the same as the given tableau.

Reimplemented from vgui_tableau.

Definition at line 54 of file vgui_wrapper_tableau.cxx.

vcl_string vgui_wrapper_tableau::file_name (  )  const [virtual]

Returns the child's file_name if it exists.

Reimplemented from vgui_tableau.

Definition at line 37 of file vgui_wrapper_tableau.cxx.

vcl_string vgui_wrapper_tableau::pretty_name (  )  const [virtual]

Returns nice version of the name which also includes details of the child.

Reimplemented from vgui_tableau.

Definition at line 32 of file vgui_wrapper_tableau.cxx.

vcl_string vgui_wrapper_tableau::type_name (  )  const [virtual]

Returns the type of tableau ('vgui_wrapper_tableau').

Reimplemented from vgui_tableau.

Reimplemented in vgui_active_tableau, vgui_blackbox_tableau, vgui_debug_tableau, vgui_event_server_interpose_tableau, vgui_loader_tableau, vgui_tview_tableau, vgui_viewer2D_tableau, and vgui_viewer3D_tableau.

Definition at line 27 of file vgui_wrapper_tableau.cxx.

bool vgui_wrapper_tableau::handle ( vgui_event const &  e  )  [virtual]

Handle all events sent to this tableau.

It is pointless to derive from vgui_wrapper_tableau unless this method is also overridden!

Reimplemented from vgui_tableau.

Reimplemented in vgui_active_tableau, vgui_blackbox_tableau, vgui_debug_tableau, vgui_event_server_interpose_tableau, vgui_loader_tableau, vgui_tview_tableau, vgui_viewer2D_tableau, and vgui_viewer3D_tableau.

Definition at line 66 of file vgui_wrapper_tableau.cxx.

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

Get the bounding box for this tableau.

Defaults to getting the bounding box of the child.

Reimplemented from vgui_tableau.

Definition at line 71 of file vgui_wrapper_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.

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.

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

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::mouse_down ( int  x,
int  y,
vgui_button  ,
vgui_modifier   
) [virtual, inherited]

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

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

Definition at line 126 of file vgui_tableau.cxx.

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

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

Reimplemented in vgui_function_tableau, vgui_viewer2D_tableau, and vgui_viewer3D_tableau.

Definition at line 136 of file vgui_tableau.cxx.

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

Called by handle when it receives a mouse motion event.

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

Reimplemented in vgui_displaylist2D_tableau, vgui_function_tableau, and vgui_listmanager2D_tableau.

Definition at line 146 of file vgui_tableau.cxx.

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

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_function_tableau, vgui_listmanager2D_tableau, vgui_viewer2D_tableau, and vgui_viewer3D_tableau.

Definition at line 156 of file vgui_tableau.cxx.

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

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

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

Definition at line 166 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

The single child of this tableau.

Definition at line 65 of file vgui_wrapper_tableau.h.


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

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