Tableau to turn a non-tableau into a multi-tableau (with client data). More...
#include <vgui_satellite_tableau.h>
Public Types | |
| typedef bool(object::* | method )(vgui_event const &, data) |
Public Member Functions | |
| vgui_satellite_tableau_t (object *p_, method m_, data const &d_, vcl_string const &n_="") | |
| Constructor - don't use this, use vgui_satellite_tableau_t_new. | |
| bool | handle (vgui_event const &e) |
| Handle all events sent to this tableau. | |
| vcl_string | type_name () const |
| Return name of most derived class (for RTTI purposes). | |
| void | add_popup (vgui_menu &mnu) |
| Add the given menu to the popup menu for the tableau. | |
| 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 | 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 | 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. | |
Public Attributes | |
| object * | p |
| The 'object' type must have a method type_name(). | |
| method | m |
| data | d |
| Client data. | |
| vcl_string | n |
| Name. | |
| vgui_menu | a_menu |
Protected Member Functions | |
| ~vgui_satellite_tableau_t () | |
Detailed Description
template<class object, class data>
struct vgui_satellite_tableau_t< object, data >
Tableau to turn a non-tableau into a multi-tableau (with client data).
PURPOSE: To turn a non-tableau into a multi-tableau, or to put one tableau into two parts of the tree simultaneously.
EXAMPLE: We are displaying two images, each in its own zoomer and we'd like to have a tableau which takes mouse events from one image and draws a line on the other. This introduces a "crossover" in the tree which is difficult to handle without vgui_satellite_tableau.
The basic layout we want is like this:
Adaptor
|
|
grid
/ \ .
/ \ .
/ \ .
zoom zoom
| |
\ /
draw_on_both_children_tableau ("dob")
/ \ .
| |
image image
But a single tableau cannot have multiple paths through "handle", so we might split "dob" into two helper tableaux, which each hold a pointer to the data required to implement the drawing. Then the "handle" methods of each of the helpers are just small stubs which call the handle method on "dob", telling it whether it's in the "left" tree or the "right" tree.
Adaptor
|
|
---- grid ----
/ \ .
zoom zoom
| |
| |
dob1 - -> dob <- - dob2
/ \ .
/ \ .
"handle(e,1)"+ +"handle(e,2)"
| |
| |
image image
However, this is a small bit of hassle for the writer of "dob", which vgui_satellite_tableau makes easier. Add an extra argument to dob::handle(event), which indicates which side the event is on, and then put a vgui_satellite_tableau_t<type_of_dob, int>(dob, 1) in the left tree and a vgui_satellite_tableau_t<type_of_dob, int>(dob, 2) in the right tree. Then whenever an event goes down the tree the satellites call dob::handle with a 1 or a 2, so dob knows which way to pass it on...
Definition at line 88 of file vgui_satellite_tableau.h.
Member Typedef Documentation
| typedef bool(object::* vgui_satellite_tableau_t< object, data >::method)(vgui_event const &, data) |
Definition at line 90 of file vgui_satellite_tableau.h.
Constructor & Destructor Documentation
| vgui_satellite_tableau_t< object, data >::vgui_satellite_tableau_t | ( | object * | p_, |
| method | m_, | ||
| data const & | d_, | ||
| vcl_string const & | n_ = "" |
||
| ) | [inline] |
Constructor - don't use this, use vgui_satellite_tableau_t_new.
There is no vgui_satellite_tableau_t_sptr for this tableau.
Definition at line 112 of file vgui_satellite_tableau.h.
| vgui_satellite_tableau_t< object, data >::~vgui_satellite_tableau_t | ( | ) | [inline, protected] |
Definition at line 125 of file vgui_satellite_tableau.h.
Member Function Documentation
| 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_selector_tableau, vgui_deck_tableau, and vgui_wrapper_tableau.
Definition at line 284 of file vgui_tableau.cxx.
| void vgui_satellite_tableau_t< object, data >::add_popup | ( | vgui_menu & | ) | [inline, 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 from vgui_tableau.
Definition at line 122 of file vgui_satellite_tableau.h.
| 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::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.
| 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_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, inherited] |
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, 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_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 [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_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.
| 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_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_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_satellite_tableau_t< object, data >::handle | ( | vgui_event const & | event | ) | [inline, 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 from vgui_tableau.
Definition at line 116 of file vgui_satellite_tableau.h.
| bool vgui_tableau::help | ( | ) | [virtual, inherited] |
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, 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.
| 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_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, 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_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, inherited] |
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, inherited] |
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, inherited] |
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, 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::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.
| 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_overlay_redraw | ( | void | ) | [virtual, inherited] |
Post an overlay-redraw event.
Post an 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_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.
| 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_easy2D_tableau, vgui_deck_tableau, vgui_composite_tableau, vgui_roi_tableau, vgui_image_tableau, vgui_selector_tableau, vgui_wrapper_tableau, and vgui_vrml_tableau.
Definition at line 97 of file vgui_tableau.h.
| 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.
| 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_selector_tableau, vgui_deck_tableau, and vgui_wrapper_tableau.
Definition at line 291 of file vgui_tableau.cxx.
| vcl_string vgui_satellite_tableau_t< object, data >::type_name | ( | ) | const [inline, virtual] |
Return name of most derived class (for RTTI purposes).
Return the name of the most derived (tableau) class.
Virtual. This ought never to be called as derived classes should implement type_name().
Reimplemented from vgui_tableau.
Definition at line 118 of file vgui_satellite_tableau.h.
| 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
| vgui_menu vgui_satellite_tableau_t< object, data >::a_menu |
Definition at line 121 of file vgui_satellite_tableau.h.
| data vgui_satellite_tableau_t< object, data >::d |
Client data.
The 'data' parameter may seem superfluous because one could achieve the same result by having two methods which were used to initialize the satellites. However, if the number of satellites is unknown at compile time, or if there are many of them and it is easier to generate them in code, then the 'data' parameter is necessary.
Definition at line 105 of file vgui_satellite_tableau.h.
| method vgui_satellite_tableau_t< object, data >::m |
Definition at line 96 of file vgui_satellite_tableau.h.
| vcl_string vgui_satellite_tableau_t< object, data >::n |
Name.
Definition at line 108 of file vgui_satellite_tableau.h.
| object* vgui_satellite_tableau_t< object, data >::p |
The 'object' type must have a method type_name().
It is used to implement the type_name() methods on the satellites.
Definition at line 94 of file vgui_satellite_tableau.h.
The documentation for this struct was generated from the following file:
- core/vgui/vgui_satellite_tableau.h
