berry::CommandContributionItemParameter Class Reference

#include <berryCommandContributionItemParameter.h>

Inheritance diagram for berry::CommandContributionItemParameter:

Collaboration diagram for berry::CommandContributionItemParameter:

Public Member Functions
	berryObjectMacro (CommandContributionItemParameter)
	CommandContributionItemParameter (IServiceLocator *serviceLocator, const QString &id, const QString &commandId, CommandContributionItem::Style style)
	CommandContributionItemParameter (IServiceLocator *serviceLocator, const QString &id, const QString &commandId, const QHash< QString, Object::Pointer > &parameters, const QIcon &icon, const QString label, const QChar &mnemonic, const QString &tooltip, CommandContributionItem::Style style, const QString &helpContextId, bool visibleEnabled)
Public Member Functions inherited from berry::Object
virtual QString	GetClassName () const
virtual Reflection::TypeInfo	GetTypeInfo () const
virtual QList< Reflection::TypeInfo >	GetSuperclasses () const
virtual void	Delete ()
QDebug	Print (QDebug os, Indent Indent=0) const
virtual QString	ToString () const
virtual uint	HashCode () const
virtual bool	operator< (const Object *) const
void	Register () const
void	UnRegister (bool del=true) const
int	GetReferenceCount () const
void	SetReferenceCount (int)
void	AddDestroyListener (const MessageAbstractDelegate<> &delegate) const
void	RemoveDestroyListener (const MessageAbstractDelegate<> &delegate) const
virtual bool	operator== (const Object *) const

Public Attributes
IServiceLocator *	serviceLocator
QString	id
QString	commandId
QHash< QString, Object::Pointer >	parameters
QIcon	icon
QString	label
QChar	mnemonic
QKeySequence	shortcut
QString	tooltip
CommandContributionItem::Style	style
QString	helpContextId
QString	iconStyle
bool	visibleEnabled
CommandContributionItem::Modes	mode

Additional Inherited Members
Public Types inherited from berry::Object
typedef Object	Self
typedef berry::SmartPointer< Self >	Pointer
typedef berry::SmartPointer< const Self >	ConstPointer
typedef berry::WeakPointer< Self >	WeakPtr
typedef berry::WeakPointer< const Self >	ConstWeakPtr
Static Public Member Functions inherited from berry::Object
static const char *	GetStaticClassName ()
static Reflection::TypeInfo	GetStaticTypeInfo ()
static QList< Reflection::TypeInfo >	GetStaticSuperclasses ()
Protected Member Functions inherited from berry::Object
	Object ()
virtual	~Object ()
virtual QDebug	PrintSelf (QDebug os, Indent indent) const
virtual QDebug	PrintHeader (QDebug os, Indent indent) const
virtual QDebug	PrintTrailer (QDebug os, Indent indent) const
Protected Attributes inherited from berry::Object
QAtomicInt	m_ReferenceCount
QMutex	m_ReferenceCountLock

Detailed Description

A help class for the various parameters that can be used with command contributions. Mandatory parameters are in the constructor, and public fields can be set to fill in other parameters.

Definition at line 32 of file berryCommandContributionItemParameter.h.

Constructor & Destructor Documentation

CommandContributionItemParameter() [1/2]

berry::CommandContributionItemParameter::CommandContributionItemParameter	(	IServiceLocator *	serviceLocator,
		const QString &	id,
		const QString &	commandId,
		CommandContributionItem::Style	style
	)

Create the parameter object. Nullable attributes can be set directly.

Parameters

serviceLocator	a service locator that is most appropriate for this contribution. Typically the local IWorkbenchWindow or IWorkbenchPartSite will be sufficient. Must not be null.
id	The id for this item. May be null. Items without an id cannot be referenced later.
commandId	A command id for a defined command. Must not be null.
style	The style of this menu contribution. See the STYLE_* contants.

CommandContributionItemParameter() [2/2]

berry::CommandContributionItemParameter::CommandContributionItemParameter	(	IServiceLocator *	serviceLocator,
		const QString &	id,
		const QString &	commandId,
		const QHash< QString, Object::Pointer > &	parameters,
		const QIcon &	icon,
		const QString	label,
		const QChar &	mnemonic,
		const QString &	tooltip,
		CommandContributionItem::Style	style,
		const QString &	helpContextId,
		bool	visibleEnabled
	)

Build the parameter object.

Note: This constructor should not be called outside the framework.

Parameters

serviceLocator	a service locator that is most appropriate for this contribution. Typically the local IWorkbenchWindow or IWorkbenchPartSite will be sufficient. Must not be null.
id	The id for this item. May be null. Items without an id cannot be referenced later.
commandId	A command id for a defined command. Must not be null.
parameters	A map of strings to strings which represent parameter names to values. The parameter names must match those in the command definition. May be null
icon	An icon for this item. May be null.
label	A label for this item. May be null.
mnemonic	A mnemonic for this item to be applied to the label. May be null.
tooltip	A tooltip for this item. May be null. Tooltips are currently only valid for toolbar contributions.
style	The style of this menu contribution. See the STYLE_* contants.
helpContextId	the help context id to be applied to this contribution. May be null
visibleEnabled	Visibility tracking for the menu contribution.

Note

This constructor is not intended to be referenced by clients.

Member Function Documentation

berryObjectMacro()

berry::CommandContributionItemParameter::berryObjectMacro

(

CommandContributionItemParameter

)

Member Data Documentation

commandId

QString berry::CommandContributionItemParameter::commandId

A command id for a defined command. Must not be null.

Definition at line 56 of file berryCommandContributionItemParameter.h.

helpContextId

QString berry::CommandContributionItemParameter::helpContextId

The help context id to be applied to this contribution. May be null

Definition at line 103 of file berryCommandContributionItemParameter.h.

icon

QIcon berry::CommandContributionItemParameter::icon

An icon for this item. May be null.

Definition at line 68 of file berryCommandContributionItemParameter.h.

iconStyle

QString berry::CommandContributionItemParameter::iconStyle

The icon style to use.

Definition at line 108 of file berryCommandContributionItemParameter.h.

id

QString berry::CommandContributionItemParameter::id

The id for this item. May be null. Items without an id cannot be referenced later.

Definition at line 51 of file berryCommandContributionItemParameter.h.

label

QString berry::CommandContributionItemParameter::label

A label for this item. May be null.

Definition at line 73 of file berryCommandContributionItemParameter.h.

mnemonic

QChar berry::CommandContributionItemParameter::mnemonic

A mnemonic for this item to be applied to the label. May be null.

Definition at line 79 of file berryCommandContributionItemParameter.h.

mode

CommandContributionItem::Modes berry::CommandContributionItemParameter::mode

Any number of mode bits, like CommandContributionItem#MODE_FORCE_TEXT.

Definition at line 119 of file berryCommandContributionItemParameter.h.

parameters

QHash<QString, Object::Pointer> berry::CommandContributionItemParameter::parameters

A map of strings to strings which represent parameter names to values. The parameter names must match those in the command definition. May be null

Definition at line 63 of file berryCommandContributionItemParameter.h.

serviceLocator

IServiceLocator* berry::CommandContributionItemParameter::serviceLocator

a service locator that is most appropriate for this contribution. Typically the local IWorkbenchWindow or IWorkbenchPartSite will be sufficient. Must not be null.

Definition at line 45 of file berryCommandContributionItemParameter.h.

shortcut

QKeySequence berry::CommandContributionItemParameter::shortcut

A shortcut key sequence. This is a workaround and will be removed when key binding support is fully implemented

Definition at line 85 of file berryCommandContributionItemParameter.h.

style

CommandContributionItem::Style berry::CommandContributionItemParameter::style

The style of this menu contribution. See the CommandContributionItem STYLE_* contants.

Definition at line 97 of file berryCommandContributionItemParameter.h.

tooltip

QString berry::CommandContributionItemParameter::tooltip

A tooltip for this item. May be null. Tooltips are currently only valid for toolbar contributions.

Definition at line 91 of file berryCommandContributionItemParameter.h.

visibleEnabled

bool berry::CommandContributionItemParameter::visibleEnabled

The visibility tracking for a menu contribution.

Definition at line 113 of file berryCommandContributionItemParameter.h.

---

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

• berryCommandContributionItemParameter.h