VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
makVrv::DtToolbarPath Class Reference

a Class which represents a toolbar path. The specific strings are not toolbar text, but the names used when registering toolbarBuilder, menuBuilder and menuItemBuilder instances.

DtToolbarPath::toolbar("FileMenu").item("ExitItem");
DtToolbarPath::toolbar("FileMenu").menu("OpenMenu");
DtToolbarPath::toolbar("FileMenu").separator("FileMenuSeparator");
DtToolbarPath::toolbar("FileMenu").widget("FileMode");
If you want to start a new row or add a toolbar to a particular row, use the row("") modifier:
DtToolbarPath::row("Top_Row").toolbar("FileMenu");
Note that any item that is not attached to a row is considered to be added to the last row defined. Any new
row will create a new toolbar break

A toolbar differs from a menu only in that the root is the name of a toolbar

Inheritance diagram for makVrv::DtToolbarPath:
Inheritance graph
[legend]

Classes

struct  ToolbarPathBuilder
 

Public Member Functions

 DtToolbarPath ()
 
 DtToolbarPath (const ToolbarPathBuilder &builder)
 
 DtToolbarPath (const DtMenuPath &copy)
 
 DtToolbarPath (const DtToolbarPath &copy)
 
DtToolbarPath menuPart () const
 
DtToolbarPath toolbarPart () const
 
DtToolbarPath parentMenu () const
 
bool isChildOf (const DtToolbarPath &parent) const
 
bool isDescendant (const DtToolbarPath &ancestor) const
 
bool isSiblingOf (const DtToolbarPath &sibling) const
 
bool isToolbar () const
 
bool isAbsolutePath () const
 
bool isWidget () const
 
const std::string & path () const
 
bool isEmpty () const
 
bool isItem () const
 
bool isMainMenu () const
 
bool isSeparator () const
 
bool isMenu () const
 
bool isRow () const
 
DtToolbarPath rootParentMenu () const
 
std::string name () const
 
bool operator== (const DtToolbarPath &other) const
 
bool operator< (const DtToolbarPath &other) const
 
bool operator!= (const DtToolbarPath &other) const
 

Static Public Member Functions

static ToolbarPathBuilder toolbar (const std::string &name)
 
static ToolbarPathBuilder row (const std::string &name)
 
static DtToolbarPath empty ()
 
static DtToolbarPath root ()
 

Protected Member Functions

template<class Archive >
void _serialize (Archive &ar, const unsigned int version)
 
 DtToolbarPath (const std::string &path)
 

Protected Attributes

std::string myPath
 

Constructor & Destructor Documentation

makVrv::DtToolbarPath::DtToolbarPath ( )
makVrv::DtToolbarPath::DtToolbarPath ( const ToolbarPathBuilder builder)
makVrv::DtToolbarPath::DtToolbarPath ( const DtMenuPath copy)
makVrv::DtToolbarPath::DtToolbarPath ( const DtToolbarPath copy)

Copy CTOR.

makVrv::DtToolbarPath::DtToolbarPath ( const std::string &  path)
protected

Protected CTOR, use the static MenuMenu function to start a path.

Member Function Documentation

static ToolbarPathBuilder makVrv::DtToolbarPath::toolbar ( const std::string &  name)
static
static ToolbarPathBuilder makVrv::DtToolbarPath::row ( const std::string &  name)
static
static DtToolbarPath makVrv::DtToolbarPath::empty ( )
static
static DtToolbarPath makVrv::DtToolbarPath::root ( )
static
DtToolbarPath makVrv::DtToolbarPath::menuPart ( ) const

Get the menu path part of this path. Typically this will remove the item, however it will simply return a copy is the path has no item.

DtToolbarPath makVrv::DtToolbarPath::toolbarPart ( ) const

Get the part that is the toolbar.

DtToolbarPath makVrv::DtToolbarPath::parentMenu ( ) const

Returns the parent of this item.

bool makVrv::DtToolbarPath::isChildOf ( const DtToolbarPath parent) const

Is this path it's direct parent.

bool makVrv::DtToolbarPath::isDescendant ( const DtToolbarPath ancestor) const

Is this path under the given path.

bool makVrv::DtToolbarPath::isSiblingOf ( const DtToolbarPath sibling) const

Does this path have the same parent as the given path.

bool makVrv::DtToolbarPath::isToolbar ( ) const

Returns true if this path is a toolbar.

bool makVrv::DtToolbarPath::isAbsolutePath ( ) const

Is this path rooted off a toolbar.

bool makVrv::DtToolbarPath::isWidget ( ) const

Returns true if the item is a widget.

const std::string& makVrv::DtToolbarPath::path ( ) const
inline
bool makVrv::DtToolbarPath::isEmpty ( ) const

Is the path empty.

bool makVrv::DtToolbarPath::isItem ( ) const

Is the path an item?

bool makVrv::DtToolbarPath::isMainMenu ( ) const

Does the path contain a main menu?

bool makVrv::DtToolbarPath::isSeparator ( ) const

Is this path for a separator.

bool makVrv::DtToolbarPath::isMenu ( ) const

Is the path a menu (not an item)?

bool makVrv::DtToolbarPath::isRow ( ) const

Is the path a row item?

DtToolbarPath makVrv::DtToolbarPath::rootParentMenu ( ) const

Get the root parent of this path.

std::string makVrv::DtToolbarPath::name ( ) const

Get the name of the this menu path, this is either the item name or the menu name.

bool makVrv::DtToolbarPath::operator== ( const DtToolbarPath other) const
bool makVrv::DtToolbarPath::operator< ( const DtToolbarPath other) const
bool makVrv::DtToolbarPath::operator!= ( const DtToolbarPath other) const
template<class Archive >
void makVrv::DtToolbarPath::_serialize ( Archive &  ar,
const unsigned int  version 
)
inlineprotected

Serialize this class.

References DT_SERIALIZE_MEMBER.

Member Data Documentation

std::string makVrv::DtToolbarPath::myPath
protected

Internal path.


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

Document ID: Generated on Thu Oct 23 22:29:17 EDT 2025 from SVN revision 280951
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)