Rogue Wave Views
Application Framework Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvDvBarSet Class Reference

Application Framework bar set class. More...

#include <ilviews/appframe/dockcfg.h>

Public Member Functions

 IlvDvBarSet ()
 Constructs an IlvDvBarSet object. More...
 
void addToolBar (const char *name, IlvToolBar *bar)
 Adds a toolbar to the set. More...
 
IlUInt getBarsCount () const
 Gets the number of toolbars stored in the set. More...
 
IlUInt getIndex (const IlvToolBar *bar) const
 Gets the storage index in the set of the bar given as the parameter. More...
 
IlvPanegetPane (IlUInt index) const
 Gets the pane at a given index. More...
 
IlvToolBargetToolBar (IlUInt index) const
 Gets a toolbar. More...
 
IlvToolBargetToolBarByName (const char *name) const
 Retrieves from the set the toolbar whose name is given by the parameter name. More...
 
IlvPaneremoveBar (const IlvToolBar *bar)
 Removes a toolbar from the set. More...
 

Detailed Description

Application Framework bar set class.

Library: ilvappframe

The IlvDvBarSet class handles a set of bars. It is used by the document templates to store their toolbars and give them to the main window for docking.

Constructor & Destructor Documentation

IlvDvBarSet::IlvDvBarSet ( )

Constructs an IlvDvBarSet object.

This constructor initializes a new IlvDvBarSet instance.

Member Function Documentation

void IlvDvBarSet::addToolBar ( const char *  name,
IlvToolBar bar 
)

Adds a toolbar to the set.

Adds the toolbar with the parameter bar and the name name to the set.

IlUInt IlvDvBarSet::getBarsCount ( ) const

Gets the number of toolbars stored in the set.

Returns
The number of toolbars stored in the set.
IlUInt IlvDvBarSet::getIndex ( const IlvToolBar bar) const

Gets the storage index in the set of the bar given as the parameter.

Returns
The storage index in the set of the given bar.
IlvPane* IlvDvBarSet::getPane ( IlUInt  index) const

Gets the pane at a given index.

Gets the pane of the main window that handles the toolbar stored at index index.

Returns
The pane of the toolbar stored at the given index.
IlvToolBar* IlvDvBarSet::getToolBar ( IlUInt  index) const

Gets a toolbar.

Gets the toolbar from the set stored at position index.

Returns
The toolbar of the set stored at the given position.
IlvToolBar* IlvDvBarSet::getToolBarByName ( const char *  name) const

Retrieves from the set the toolbar whose name is given by the parameter name.

Returns
The toolbar with the given name from the set.
IlvPane* IlvDvBarSet::removeBar ( const IlvToolBar bar)

Removes a toolbar from the set.

Removes the toolbar with parameter bar from the set.

Returns
The pane containing the toolbar.

© Copyright 2016, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.