A slider implementation. More...

#include <vgui_slider_tableau.h>

Inheritance diagram for vgui_slider_tableau:

Classes
struct	callback_info
Public Types
enum	slider_type { horiz, vert }
	Direction of slider. More...
typedef void(*	callback )(vgui_slider_tableau tab, void data)
	Callback function type.
typedef vcl_list < callback_info >::iterator	cb_handle
	A handle used to refer to callback functions added to this slider.
Public Member Functions
cb_handle	add_motion_callback (callback cb, void *data)
	Add a callback.
cb_handle	add_final_callback (callback cb, void *data)
	Add a callback.
void	remove_motion_callback (cb_handle cbh)
	Remove a callback.
void	remove_final_callback (cb_handle cbh)
	Remove a callback.
float	value () const
	Current value of the slider, in [0,1].
void	set_value (float v)
	Set the slider to value v.
void	set_value_no_callbacks (float v)
	Set the slider to value v.
	~vgui_slider_tableau ()
virtual bool	handle (const vgui_event &)
	Handle all events sent to this 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.
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	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.
Private Member Functions
void	draw_bar () const
	Draw the slider at the current position.
void	call_callbacks (vcl_list< callback_info > const &cbs)
	Call each of the callbacks in cbs.
void	update_location (int newx, int newy)
	Update the slider location.
	vgui_slider_tableau (slider_type type)
	Constructor - don't use this, use vgui_slider_tableau_new.
Private Attributes
float	loc_
	Current location of slider, in [0:1].
bool	horiz_
	Slider is horizontal or vertical?.
bool	down_
	Mouse is currently pressed?.
float	last_loc_
	Location of bar when mouse was pressed.
int	last_x_
	Window coords of last mouse press.
int	last_y_
vcl_list< callback_info >	motion_callbacks_
	Callbacks called on every change of the slider.
vcl_list< callback_info >	final_callbacks_
	Callbacks called only at the final position of the slider.
Friends
struct	vgui_slider_tableau_new

Detailed Description

A slider implementation.

Implements a tableau that can be used as a slider. This can be used to provide platform-independent scrollbar-like capabilities. (It may be stretching the design parameters of vgui, but hey...)

One use of it is in conjunction with vgui_poly_tableau to place the slider somewhere. For example:

   vgui_tableau_sptr main_tab; // some tableau
   vgui_slider_tableau_new slider_h( vgui_slider_tableau::horiz );
   vgui_slider_tableau_new slider_v( vgui_slider_tableau::vert );
   vgui_poly_tableau_new poly;
   poly->add( easy_tab, 0.1, 0.1, 0.9, 0.9 );
   poly->add( slider_h, 0.1, 0.0, 0.9, 0.1 );
   poly->add( slider_v, 0.0, 0.1, 0.1, 0.9 );

Definition at line 30 of file vgui_slider_tableau.h.

Member Typedef Documentation

typedef void(* vgui_slider_tableau::callback)(vgui_slider_tableau *tab, void *data)

Callback function type.

The parameter tab will be a pointer to the slider tableau performing the callback. data contains data that was specified when this callback was registered.

Definition at line 42 of file vgui_slider_tableau.h.

typedef vcl_list< callback_info >::iterator vgui_slider_tableau::cb_handle

A handle used to refer to callback functions added to this slider.

Definition at line 57 of file vgui_slider_tableau.h.

Member Enumeration Documentation

enum vgui_slider_tableau::slider_type

Direction of slider.

Enumerator:

horiz
vert

Definition at line 35 of file vgui_slider_tableau.h.

Constructor & Destructor Documentation

vgui_slider_tableau::~vgui_slider_tableau ( )

Definition at line 17 of file vgui_slider_tableau.cxx.

vgui_slider_tableau::vgui_slider_tableau ( slider_type type ) [private]

Constructor - don't use this, use vgui_slider_tableau_new.

Definition at line 10 of file vgui_slider_tableau.cxx.

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.

vgui_slider_tableau::cb_handle vgui_slider_tableau::add_final_callback	(	callback	cb,
		void *	data
	)

Add a callback.

The callback function cb will be called whenever user finished picking a new slider value. The callback function will be provided the data in data as the second parameter.

Definition at line 94 of file vgui_slider_tableau.cxx.

vgui_slider_tableau::cb_handle vgui_slider_tableau::add_motion_callback	(	callback	cb,
		void *	data
	)

Add a callback.

The callback function cb will be called whenever the slider value changes. The callback function will be provided the data in data as the second parameter.

Definition at line 87 of file vgui_slider_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_satellite_tableau_t< object, data >, vgui_active_tableau, and vgui_clear_tableau.

Definition at line 316 of file vgui_tableau.cxx.

void vgui_slider_tableau::call_callbacks ( vcl_list< callback_info > const & cbs ) [private]

Call each of the callbacks in cbs.

Definition at line 136 of file vgui_slider_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.

void vgui_slider_tableau::draw_bar ( ) const [private]

Draw the slider at the current position.

Definition at line 53 of file vgui_slider_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_slider_tableau::handle ( const vgui_event & 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 from vgui_tableau.

Definition at line 23 of file vgui_slider_tableau.cxx.

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.

void vgui_slider_tableau::remove_final_callback ( cb_handle cbh )

Remove a callback.

cbh is the handle returned by add_final_callback() when the callback was added to this slider.

Definition at line 108 of file vgui_slider_tableau.cxx.

void vgui_slider_tableau::remove_motion_callback ( cb_handle cbh )

Remove a callback.

cbh is the handle returned by add_motion_callback() when the callback was added to this slider.

Definition at line 101 of file vgui_slider_tableau.cxx.

void vgui_slider_tableau::set_value ( float v )

Set the slider to value v.

v will be clipped to [0,1]. The callbacks associated with the slider will be called, as if the slider was changed interactively.

Definition at line 115 of file vgui_slider_tableau.cxx.

void vgui_slider_tableau::set_value_no_callbacks ( float v )

Set the slider to value v.

v will be clipped to [0,1]. The callbacks will not be called.

Definition at line 123 of file vgui_slider_tableau.cxx.

vcl_string vgui_tableau::type_name ( ) const [virtual, inherited]

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 in vgui_rubberband_tableau, vgui_satellite_tableau< object >, vgui_satellite_tableau_t< object, data >, vgui_shell_tableau, vgui_easy2D_tableau, vgui_deck_tableau, vgui_poly_tableau, vgui_composite_tableau, vgui_grid_tableau, vgui_blender_tableau, vgui_roi_tableau, vgui_enhance_tableau, vgui_wrapper_tableau, vgui_blackbox_tableau, vgui_text_tableau, vgui_selector_tableau, vgui_listmanager2D_tableau, vgui_active_tableau, vgui_image_tableau, vgui_loader_tableau, vgui_tview_launcher_tableau, vgui_viewer2D_tableau, vgui_vrml_tableau, vgui_function_tableau, vgui_clear_tableau, vgui_viewer3D_tableau, vgui_easy3D_tableau, vgui_debug_tableau, vgui_tview_tableau, vgui_adaptor_tableau, vgui_displaylist3D_tableau, vgui_quit_tableau, and vgui_event_server_interpose_tableau.

Definition at line 248 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.

void vgui_slider_tableau::update_location	(	int	newx,
		int	newy
	)		`[private]`

Update the slider location.

newx and newy give the latest mouse position in window coordinates

Definition at line 149 of file vgui_slider_tableau.cxx.

float vgui_slider_tableau::value ( ) const [inline]

Current value of the slider, in [0,1].

Definition at line 86 of file vgui_slider_tableau.h.

Friends And Related Function Documentation

friend struct vgui_slider_tableau_new [friend]

Definition at line 115 of file vgui_slider_tableau.h.

Member Data Documentation

bool vgui_slider_tableau::down_ [private]

Mouse is currently pressed?.

Definition at line 127 of file vgui_slider_tableau.h.

vcl_list< callback_info > vgui_slider_tableau::final_callbacks_ [private]

Callbacks called only at the final position of the slider.

Definition at line 139 of file vgui_slider_tableau.h.

bool vgui_slider_tableau::horiz_ [private]

Slider is horizontal or vertical?.

Definition at line 124 of file vgui_slider_tableau.h.

float vgui_slider_tableau::last_loc_ [private]

Location of bar when mouse was pressed.

Definition at line 130 of file vgui_slider_tableau.h.

int vgui_slider_tableau::last_x_ [private]

Window coords of last mouse press.

Definition at line 133 of file vgui_slider_tableau.h.

int vgui_slider_tableau::last_y_ [private]

Definition at line 133 of file vgui_slider_tableau.h.

float vgui_slider_tableau::loc_ [private]

Current location of slider, in [0:1].

Definition at line 121 of file vgui_slider_tableau.h.

vcl_list< callback_info > vgui_slider_tableau::motion_callbacks_ [private]

Callbacks called on every change of the slider.

Definition at line 136 of file vgui_slider_tableau.h.

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

core/vgui/vgui_slider_tableau.h
core/vgui/vgui_slider_tableau.cxx

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation