IlvDvBarSet Class Reference

Application Framework bar set class. More...

#include <ilviews/appframe/dockcfg.h>

List of all members.

Public Member Functions
	IlvDvBarSet ()
	Constructs an IlvDvBarSet object.
void	addToolBar (const char *name, IlvToolBar *bar)
	Adds a toolbar to the set.
IlUInt	getBarsCount () const
	Gets the number of toolbars stored in the set.
IlUInt	getIndex (const IlvToolBar *bar) const
	Gets the storage index in the set of the bar given as the parameter.
IlvPane *	getPane (IlUInt index) const
	Gets the pane at a given index.
IlvToolBar *	getToolBar (IlUInt index) const
	Gets a toolbar.
IlvToolBar *	getToolBarByName (const char *name) const
	Retrieves from the set the toolbar whose name is given by the parameter name.
IlvPane *	removeBar (const IlvToolBar *bar)
	Removes a toolbar from the set.

---

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.