DtToolbarFactoryManager Class Reference

This structure will be used to create a widget that is added to a toolbar. More...

Inheritance diagram for DtToolbarFactoryManager:

List of all members.

Signals
void	contextMenuEvent (QWidget *, QContextMenuEvent *)
Public Member Functions
	DtToolbarFactoryManager (const QString &name="toolbarFactoryManager")
	DtToolbarFactoryManager (const DtToolbarFactoryManager &)
virtual	~DtToolbarFactoryManager ()
virtual bool	init (DtFeatureActionManager *)
void	setUserToolbarSystemEnabled (bool)
	Enables/disables user toolbar system. Default is enabled.
bool	userToolbarSystemEnabled () const
DtToolbarFactoryManager &	operator= (const DtToolbarFactoryManager &)
virtual void	write (QTextStream &)
	Archives object to/from stream (only archives editable items), and, as such, will merge them into the current factory after read.
virtual void	read (QTextStream &)
	Reads/writes archiver.
virtual void	clear ()
virtual void	addToolbar (const QString &toolbar, const QString &windowTitle, const QString &toolTip=DtKeepTooltip, bool editable=false)
	Routines associated with toolbars and toolbar creation.
virtual void	addToolbar (const DtFeatureToolbar &)
virtual void	addToolbarButton (const QString &toolbar, const QString &feature)
	Note that DtToolbarSeparator is used to create a separator on the toolbar Adds a toolbar button to a toolbar.
virtual void	addToolbarButtons (const QString &toolbar, const QVector< QString > &features)
	Adds a list of actions to the toolbar.
virtual void	addToolbarMenu (const QString &toolbar, const QString &feature, const QVector< QString > &features, const QString &toolTip=DtKeepTooltip)
	Adds a new dropdown menu to the toolbar.
virtual void	addToolbarMenuItem (const QString &toolbar, const QString &feature, const QString &itemToAdd, const QString &before=QString::null)
virtual void	removeToolbarMenuItem (const QString &toolbar, const QString &feature, const QString &item)
virtual void	setToolbarIsEditable (const QString &toolbar, bool)
	Sets whether or not the toolbar is editable by the user. The default is false.
virtual void	removeToolbar (const QString &toolbar)
	Removes the toolbar from the system.
virtual void	removeToolbarButton (const QString &toolbar, const QString &feature)
	Removes a button or series of buttons from a toolbar.
virtual void	removeToolbarButton (const QString &toolbar, int iIndex)
virtual void	removeToolbarButtons (const QString &toolbar, const QVector< QString > &features)
virtual void	removeAllToolbarButtons (const QString &toolbar)
	Removes all toolbar buttons from the particular toolbar.
virtual void	addFeatureToToolbar (const DtToolbarItem &feature, QToolBar *tool, QWidget *parent)
	Adds the particular feature to the specified toolbar.
virtual DtFeatureToolbar	toolbarFor (const QString &toolbar) const
	Returns a copy of the toolbar structure.
virtual QToolBar *	createToolBar (const QString &toolbar, QWidget *parent=NULL)
	Creates and returns a new QToolBar with the specified parent.
virtual QVector< QToolBar * >	createUserCreatedToolbars (QWidget *parent)
	Creates all user "editable" toolbars if not already created. Returns a list of created toolbars.
virtual QString	keyForToolBar (QToolBar *) const
	Returns the unique key for the specified tool bar.
virtual void	setChecked (const QString &feature, bool checked)
	If there is an action associated with this item, then, set it to be checked.
virtual bool	toolbarExists (const QString &toolbar) const
	Returns true if the toolbar exists.
virtual bool	hasToolbarNamed (const QString &name) const
	Returns true if there is a toolbar with the specified name.
virtual QString	keyForToolBar (const QString &name) const
	Returs the key for the specified toolbar name.
virtual QString	uniqueToolbarId () const
	Returns a unique id for a toolbar.
virtual void	merge (const DtToolbarFactoryManager &, bool removeMissingToolbars=true)
	Merges in supplied toobar manager.
const QHash< QString, DtFeatureToolbar > &	featureToolbars () const
virtual void	merge (const QString &toolbar, const DtFeatureToolbar &)
	Merges in the toolbar specified to the supplied toolbar information.
virtual DtToolbarFactoryManager *	clone ()
	Returns a clone of this object.
Static Public Member Functions
static DtToolbarFactoryManager *	create ()
Protected Member Functions
virtual int	indexOfFeature (const QString &toolbar, const QString &feature) const
	Returns the index of the feature in the toolbar structure. -1 if it does not exist.
virtual bool	eventFilter (QObject *, QEvent *)
	Emit signal on right click for context menu.
Protected Attributes
QHash< QString, DtFeatureToolbar >	myFeatureToolbars
DtFeatureActionManager *	myFeatureActionManager
bool	myUserToolbarSystemEnabled
QVector< QString >	myToolbarsRemoved

---

Detailed Description

This structure will be used to create a widget that is added to a toolbar.

---

Constructor & Destructor Documentation

DtToolbarFactoryManager::DtToolbarFactoryManager

(

const QString &

name = "toolbarFactoryManager"

)

DtToolbarFactoryManager::DtToolbarFactoryManager

(

const DtToolbarFactoryManager &

)

virtual DtToolbarFactoryManager::~DtToolbarFactoryManager

(

)

[virtual]

---

Member Function Documentation

virtual bool DtToolbarFactoryManager::init

(

DtFeatureActionManager *

)

[virtual]

static DtToolbarFactoryManager* DtToolbarFactoryManager::create

(

)

[static]

void DtToolbarFactoryManager::setUserToolbarSystemEnabled

(

bool

b

)

[inline]

Enables/disables user toolbar system. Default is enabled.

bool DtToolbarFactoryManager::userToolbarSystemEnabled

(

)

const [inline]

DtToolbarFactoryManager& DtToolbarFactoryManager::operator=

(

const DtToolbarFactoryManager &

)

virtual void DtToolbarFactoryManager::write

(

QTextStream &

)

[virtual]

Archives object to/from stream (only archives editable items), and, as such, will merge them into the current factory after read.

Reimplemented from DtArchivableObject.

virtual void DtToolbarFactoryManager::read

(

QTextStream &

s

)

[virtual]

Reads/writes archiver.

Reimplemented from DtArchivableObject.

virtual void DtToolbarFactoryManager::clear

(

)

[virtual]

virtual void DtToolbarFactoryManager::addToolbar	(	const QString &	toolbar,
		const QString &	windowTitle,
		const QString &	toolTip = DtKeepTooltip,
		bool	editable = false
	)		[virtual]

Routines associated with toolbars and toolbar creation.

Adds a new toolbar, title and whether or not it is editable

virtual void DtToolbarFactoryManager::addToolbar

(

const DtFeatureToolbar &

)

[virtual]

virtual void DtToolbarFactoryManager::addToolbarButton	(	const QString &	toolbar,
		const QString &	feature
	)		[virtual]

Note that DtToolbarSeparator is used to create a separator on the toolbar Adds a toolbar button to a toolbar.

If the toolbar structure does not exist, creates a new structure

virtual void DtToolbarFactoryManager::addToolbarButtons	(	const QString &	toolbar,
		const QVector< QString > &	features
	)		[virtual]

Adds a list of actions to the toolbar.

virtual void DtToolbarFactoryManager::addToolbarMenu	(	const QString &	toolbar,
		const QString &	feature,
		const QVector< QString > &	features,
		const QString &	toolTip = DtKeepTooltip
	)		[virtual]

Adds a new dropdown menu to the toolbar.

virtual void DtToolbarFactoryManager::addToolbarMenuItem	(	const QString &	toolbar,
		const QString &	feature,
		const QString &	itemToAdd,
		const QString &	before = QString::null
	)		[virtual]

virtual void DtToolbarFactoryManager::removeToolbarMenuItem	(	const QString &	toolbar,
		const QString &	feature,
		const QString &	item
	)		[virtual]

virtual void DtToolbarFactoryManager::setToolbarIsEditable	(	const QString &	toolbar,
		bool
	)		[virtual]

Sets whether or not the toolbar is editable by the user. The default is false.

virtual void DtToolbarFactoryManager::removeToolbar

(

const QString &

toolbar

)

[virtual]

Removes the toolbar from the system.

virtual void DtToolbarFactoryManager::removeToolbarButton	(	const QString &	toolbar,
		const QString &	feature
	)		[virtual]

Removes a button or series of buttons from a toolbar.

Note that if there is more than one separator, the remove must be called for each separator on the toolbar

virtual void DtToolbarFactoryManager::removeToolbarButton	(	const QString &	toolbar,
		int	iIndex
	)		[virtual]

virtual void DtToolbarFactoryManager::removeToolbarButtons	(	const QString &	toolbar,
		const QVector< QString > &	features
	)		[virtual]

virtual void DtToolbarFactoryManager::removeAllToolbarButtons

(

const QString &

toolbar

)

[virtual]

Removes all toolbar buttons from the particular toolbar.

virtual void DtToolbarFactoryManager::addFeatureToToolbar	(	const DtToolbarItem &	feature,
		QToolBar *	tool,
		QWidget *	parent
	)		[virtual]

Adds the particular feature to the specified toolbar.

virtual DtFeatureToolbar DtToolbarFactoryManager::toolbarFor

(

const QString &

toolbar

)

const [virtual]

Returns a copy of the toolbar structure.

virtual QToolBar* DtToolbarFactoryManager::createToolBar	(	const QString &	toolbar,
		QWidget *	parent = NULL
	)		[virtual]

Creates and returns a new QToolBar with the specified parent.

When creating a toolbar, if there is not already a action, it will try to create an action from the information specified. If there is no slot associated with the action, then, the button will have no effect

virtual QVector<QToolBar*> DtToolbarFactoryManager::createUserCreatedToolbars

(

QWidget *

parent

)

[virtual]

Creates all user "editable" toolbars if not already created. Returns a list of created toolbars.

virtual QString DtToolbarFactoryManager::keyForToolBar

(

QToolBar *

)

const [virtual]

Returns the unique key for the specified tool bar.

virtual void DtToolbarFactoryManager::setChecked	(	const QString &	feature,
		bool	checked
	)		[virtual]

If there is an action associated with this item, then, set it to be checked.

virtual bool DtToolbarFactoryManager::toolbarExists

(

const QString &

toolbar

)

const [virtual]

Returns true if the toolbar exists.

virtual bool DtToolbarFactoryManager::hasToolbarNamed

(

const QString &

name

)

const [virtual]

Returns true if there is a toolbar with the specified name.

virtual QString DtToolbarFactoryManager::keyForToolBar

(

const QString &

name

)

const [virtual]

Returs the key for the specified toolbar name.

virtual QString DtToolbarFactoryManager::uniqueToolbarId

(

)

const [virtual]

Returns a unique id for a toolbar.

virtual void DtToolbarFactoryManager::merge	(	const DtToolbarFactoryManager &	,
		bool	removeMissingToolbars = true
	)		[virtual]

Merges in supplied toobar manager.

Will remove any toolbars not found and delete them if they are marked as "editable". Will modify any toolbars if also marked "editable". If they are not marked as "editable", will simply remove or modify the memory structure only and not effect any existing toolbar

const QHash< QString, DtFeatureToolbar > & DtToolbarFactoryManager::featureToolbars

(

)

const [inline]

virtual void DtToolbarFactoryManager::merge	(	const QString &	toolbar,
		const DtFeatureToolbar &
	)		[virtual]

Merges in the toolbar specified to the supplied toolbar information.

virtual DtToolbarFactoryManager* DtToolbarFactoryManager::clone

(

)

[virtual]

Returns a clone of this object.

Reimplemented from DtArchivableObject.

void DtToolbarFactoryManager::contextMenuEvent	(	QWidget *	,
		QContextMenuEvent *
	)		[signal]

virtual int DtToolbarFactoryManager::indexOfFeature	(	const QString &	toolbar,
		const QString &	feature
	)		const [protected, virtual]

Returns the index of the feature in the toolbar structure. -1 if it does not exist.

virtual bool DtToolbarFactoryManager::eventFilter	(	QObject *	,
		QEvent *
	)		[protected, virtual]

Emit signal on right click for context menu.

---

Member Data Documentation

QHash<QString, DtFeatureToolbar> DtToolbarFactoryManager::myFeatureToolbars [protected]

DtFeatureActionManager* DtToolbarFactoryManager::myFeatureActionManager [protected]

bool DtToolbarFactoryManager::myUserToolbarSystemEnabled [protected]

QVector<QString> DtToolbarFactoryManager::myToolbarsRemoved [protected]

---

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

• include/commonWgt/toolbarFactoryManager.h