Functions to search for tableaux in the tableau hierarchy. More...

#include <vcl_string.h>
#include <vgui/vgui_tableau_sptr.h>

Functions
vgui_tableau_sptr	vgui_find_by_type_name (vgui_tableau_sptr const &start, vcl_string const &tn, bool direction_down)
	Search for a tableau by type in the hierarchy.
vgui_tableau_sptr	vgui_find_below_by_type_name (vgui_tableau_sptr const &start, vcl_string const &tn)
	Search for a tableau by type in the hierarchy.
vgui_tableau_sptr	vgui_find_above_by_type_name (vgui_tableau_sptr const &start, vcl_string const &tn)
	Search for a tableau by type in the hierarchy.
vgui_tableau_sptr	vgui_find_by_name (vgui_tableau_sptr const &start, vcl_string const &name, bool direction_down)
	Search for a tableau by name in the hierarchy.
vgui_tableau_sptr	vgui_find_below_by_name (vgui_tableau_sptr const &start, vcl_string const &name)
	Search for a tableau by name in the hierarchy.
vgui_tableau_sptr	vgui_find_above_by_name (vgui_tableau_sptr const &start, vcl_string const &name)
	Search for a tableau by name in the hierarchy.

Detailed Description

Functions to search for tableaux in the tableau hierarchy.

Author:: fsm

Definition in file vgui_find.h.

Function Documentation

vgui_tableau_sptr vgui_find_above_by_name	(	vgui_tableau_sptr const &	start,
		vcl_string const &	name
	)		`[inline]`

Search for a tableau by name in the hierarchy.

This is a convenience function. It calls vgui_find_by_name().

See also:: vgui_find_by_name()

Definition at line 53 of file vgui_find.h.

vgui_tableau_sptr vgui_find_above_by_type_name	(	vgui_tableau_sptr const &	start,
		vcl_string const &	tn
	)		`[inline]`

Search for a tableau by type in the hierarchy.

This is a convenience function. It calls vgui_find_by_type_name().

See also:: vgui_find_by_type_name()

Definition at line 32 of file vgui_find.h.

vgui_tableau_sptr vgui_find_below_by_name	(	vgui_tableau_sptr const &	start,
		vcl_string const &	name
	)		`[inline]`

Search for a tableau by name in the hierarchy.

This is a convenience function. It calls vgui_find_by_name().

See also:: vgui_find_by_name()

Definition at line 46 of file vgui_find.h.

vgui_tableau_sptr vgui_find_below_by_type_name	(	vgui_tableau_sptr const &	start,
		vcl_string const &	tn
	)		`[inline]`

Search for a tableau by type in the hierarchy.

This is a convenience function. It calls vgui_find_by_type_name().

See also:: vgui_find_by_type_name()

Definition at line 25 of file vgui_find.h.

vgui_tableau_sptr vgui_find_by_name	(	vgui_tableau_sptr const &	start,
		vcl_string const &	name,
		bool	direction_down
	)

Search for a tableau by name in the hierarchy.

If direction_down is true, it will search below param start. Otherwise, it will search above param start. Returns a null pointer if a matching tableau is not found.

Definition at line 39 of file vgui_find.cxx.

vgui_tableau_sptr vgui_find_by_type_name	(	vgui_tableau_sptr const &	start,
		vcl_string const &	tn,
		bool	direction_down
	)

Search for a tableau by type in the hierarchy.

If direction_down is true, it will search below param start. Otherwise, it will search above param start. Returns a null pointer if a matching tableau is not found.

Definition at line 15 of file vgui_find.cxx.