vgui_poly_tableau Class Reference

#include <vgui_poly_tableau.h>

Inheritance diagram for vgui_poly_tableau:

Inheritance graph
[legend]

List of all members.


Detailed Description

Definition at line 78 of file vgui_poly_tableau.h.


Public Types

typedef vcl_vector< itemcontainer
typedef container::iterator iterator
typedef container::const_iterator const_iterator

Public Member Functions

 vgui_poly_tableau ()
 Constructor - don't use this, use vgui_poly_tableau_new.
vcl_string type_name () const
 Returns the type of this tableau ('vgui_poly_tableau').
void get_popup (vgui_popup_params const &, vgui_menu &)
 Get popup menu.
unsigned size () const
 Returns the number of items in the list of items.
iterator begin ()
 Return an iterator pointing to the first item in the list of items.
const_iterator begin () const
 Return a const iterator pointing to the first item in the list of items.
iterator end ()
 Return an iterator pointing to the last item in the list of items.
const_iterator end () const
 Return a const iterator pointing to the last item in the list of items.
void erase (iterator)
 Erase the item at the given position from the list of items.
int add (vgui_tableau_sptr const &, float x, float y, float w, float h)
 Adds the given tableau to the given proportion of the viewport.
void remove (int id)
 Remove subtableau, referred to by handle.
void move (int id, float x, float y, float w, float h)
 Move subtableau to a new location.
void replace (int id, vgui_tableau_sptr const &tab)
 Replace the tableau with the given ID, with the given tableau.
vgui_tableau_sptr get (int id) const
 Get pointer to tableau from id.
void set_outline_color (const int id, const int r, const int g, const int b)
 Set color to outline 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 add_popup (vgui_menu &)
 Add the given menu to the 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 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

 ~vgui_poly_tableau ()
 Destructor - called by vgui_poly_tableau_sptr.
bool handle (vgui_event const &)
 Handle all events sent to this tableau.
bool handle (GLint const vp[4], vgui_event const &e)
 Handles events for this tableau and passes unused ones to the correct child.
int get_active (GLint const vp[4], int wx, int wy) const
 Misnomer - returns the index of child under the pointer's position.
int get_current () const
int get_current_id ()
 Returns the ID of the current child.
void set_current (GLint const vp[4], int index)
 Sets the child under the pointer to current.

Protected Attributes

int current
 Index of the item currently getting events.
vcl_vector< itemsub
 List of items displayed by this tableau.
bool may_switch_child

Classes

struct  item
 The position, colour, etc of the child tableau. More...

Member Typedef Documentation

typedef vcl_vector<item> vgui_poly_tableau::container

Definition at line 106 of file vgui_poly_tableau.h.

typedef container::iterator vgui_poly_tableau::iterator

Definition at line 107 of file vgui_poly_tableau.h.

typedef container::const_iterator vgui_poly_tableau::const_iterator

Definition at line 108 of file vgui_poly_tableau.h.


Constructor & Destructor Documentation

vgui_poly_tableau::vgui_poly_tableau (  ) 

Constructor - don't use this, use vgui_poly_tableau_new.

Constructor - don't use this, use vgui_poly_tableu_new.

Definition at line 78 of file vgui_poly_tableau.cxx.

vgui_poly_tableau::~vgui_poly_tableau (  )  [protected]

Destructor - called by vgui_poly_tableau_sptr.

Definition at line 87 of file vgui_poly_tableau.cxx.


Member Function Documentation

vcl_string vgui_poly_tableau::type_name (  )  const [virtual]

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

Reimplemented from vgui_tableau.

Reimplemented in vgui_grid_tableau.

Definition at line 313 of file vgui_poly_tableau.cxx.

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

Get popup menu.

Reimplemented from vgui_tableau.

Definition at line 368 of file vgui_poly_tableau.cxx.

unsigned vgui_poly_tableau::size (  )  const [inline]

Returns the number of items in the list of items.

Definition at line 111 of file vgui_poly_tableau.h.

iterator vgui_poly_tableau::begin (  )  [inline]

Return an iterator pointing to the first item in the list of items.

Definition at line 114 of file vgui_poly_tableau.h.

const_iterator vgui_poly_tableau::begin (  )  const [inline]

Return a const iterator pointing to the first item in the list of items.

Definition at line 117 of file vgui_poly_tableau.h.

iterator vgui_poly_tableau::end (  )  [inline]

Return an iterator pointing to the last item in the list of items.

Definition at line 120 of file vgui_poly_tableau.h.

const_iterator vgui_poly_tableau::end (  )  const [inline]

Return a const iterator pointing to the last item in the list of items.

Definition at line 123 of file vgui_poly_tableau.h.

void vgui_poly_tableau::erase ( iterator  i  ) 

Erase the item at the given position from the list of items.

Definition at line 93 of file vgui_poly_tableau.cxx.

int vgui_poly_tableau::add ( vgui_tableau_sptr const &  t,
float  x,
float  y,
float  w,
float  h 
)

Adds the given tableau to the given proportion of the viewport.

x,y,w,h specify a portion of the vgui_poly_tableau's viewport in coordinates which go from 0 to 1. Returns handle to child.

x,y,w,h specify a portion of the vgui_poly_tableau's viewport in coordinates which go from 0 to 1.

Definition at line 176 of file vgui_poly_tableau.cxx.

void vgui_poly_tableau::remove ( int  id  ) 

Remove subtableau, referred to by handle.

Definition at line 105 of file vgui_poly_tableau.cxx.

void vgui_poly_tableau::move ( int  id,
float  x,
float  y,
float  w,
float  h 
)

Move subtableau to a new location.

Definition at line 117 of file vgui_poly_tableau.cxx.

void vgui_poly_tableau::replace ( int  id,
vgui_tableau_sptr const &  tab 
)

Replace the tableau with the given ID, with the given tableau.

Replace the tableau with the given ID by the given tableau.

Keep the same ID and do not change the value of 'current'.

Definition at line 134 of file vgui_poly_tableau.cxx.

vgui_tableau_sptr vgui_poly_tableau::get ( int  id  )  const

Get pointer to tableau from id.

Returns the tableau with the given ID.

Definition at line 150 of file vgui_poly_tableau.cxx.

void vgui_poly_tableau::set_outline_color ( const int  id,
const int  r,
const int  g,
const int  b 
)

Set color to outline tableau.

Sets the color that the tableau is outlined with .

Definition at line 160 of file vgui_poly_tableau.cxx.

bool vgui_poly_tableau::handle ( vgui_event const &  e  )  [protected, virtual]

Handle all events sent to this tableau.

In particular, use draw events to draw the sub-rectangles.

Reimplemented from vgui_tableau.

Reimplemented in vgui_grid_tableau.

Definition at line 320 of file vgui_poly_tableau.cxx.

bool vgui_poly_tableau::handle ( GLint const   vp[4],
vgui_event const &  e 
) [protected]

Handles events for this tableau and passes unused ones to the correct child.

Definition at line 241 of file vgui_poly_tableau.cxx.

int vgui_poly_tableau::get_active ( GLint const   vp[4],
int  wx,
int  wy 
) const [protected]

Misnomer - returns the index of child under the pointer's position.

Misnomer - gets index of the child currently under the pointer's position.

Definition at line 195 of file vgui_poly_tableau.cxx.

int vgui_poly_tableau::get_current (  )  const [inline, protected]

Definition at line 164 of file vgui_poly_tableau.h.

int vgui_poly_tableau::get_current_id (  )  [protected]

Returns the ID of the current child.

Definition at line 206 of file vgui_poly_tableau.cxx.

void vgui_poly_tableau::set_current ( GLint const   vp[4],
int  index 
) [protected]

Sets the child under the pointer to current.

Definition at line 213 of file vgui_poly_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::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::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

int vgui_poly_tableau::current [protected]

Index of the item currently getting events.

Definition at line 169 of file vgui_poly_tableau.h.

vcl_vector<item> vgui_poly_tableau::sub [protected]

List of items displayed by this tableau.

Definition at line 172 of file vgui_poly_tableau.h.

Definition at line 174 of file vgui_poly_tableau.h.


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

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