#include <berryCommandContributionItem.h>

Inheritance diagram for berry::CommandContributionItem:

Collaboration diagram for berry::CommandContributionItem:

Public Member Functions
	CommandContributionItem (const SmartPointer< CommandContributionItemParameter > &contributionParameters)

	~CommandContributionItem () override

void	Fill (QMenu parent, QAction before) override

void	Fill (QToolBar parent, QAction before) override

void	Update () override

void	Update (const QString &id) override

bool	IsEnabled () const override

bool	IsVisible () const override

void	UpdateCommandPropertiesInUI (const SmartPointer< const CommandEvent > &commandEvent)

Public Member Functions inherited from berry::ContributionItem
	berryObjectMacro (ContributionItem)

void	Fill (QStatusBar *parent) override

void	Fill (QMenu menu, QAction before) override

void	Fill (QMenuBar menu, QAction before) override

void	Fill (QToolBar parent, QAction before) override

void	SaveWidgetState () override

QString	GetId () const override

IContributionManager *	GetParent () const

bool	IsDirty () const override

bool	IsEnabled () const override

bool	IsDynamic () const override

bool	IsGroupMarker () const override

bool	IsSeparator () const override

bool	IsVisible () const override

void	SetVisible (bool visible) override

QString	ToString () const override

void	Update () override

void	SetParent (IContributionManager *parent) override

void	Update (const QString &id) override

void	SetId (const QString &itemId)

Public Member Functions inherited from berry::IContributionItem
	berryObjectMacro (berry::IContributionItem)

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 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

Static Public Attributes
static Modes	modes

Additional Inherited Members
Public Types inherited from berry::ContributionItem
enum	Mode { DEFAULT, MODE_FORCE_TEXT }

enum	Style { STYLE_PUSH, STYLE_CHECK, STYLE_RADIO, STYLE_PULLDOWN }

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::ContributionItem
	ContributionItem ()

	ContributionItem (const QString &id)

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 contribution item which delegates to a command. It can be used in berry::AbstractContributionFactory::CreateContributionItems().

It currently supports placement in menus and toolbars.

This class may be instantiated; it is not intended to be subclassed.

Definition at line 47 of file berryCommandContributionItem.h.

Constructor & Destructor Documentation

◆ CommandContributionItem()

berry::CommandContributionItem::CommandContributionItem ( const SmartPointer< CommandContributionItemParameter > & contributionParameters )

Create a CommandContributionItem to place in a ContributionManager.

Parameters

contributionParameters parameters necessary to render this contribution item.

Definition at line 68 of file berryCommandContributionItem.cpp.

References berry::ContributionItem::GetId(), and berry::WorkbenchPlugin::Log().

◆ ~CommandContributionItem()

berry::CommandContributionItem::~CommandContributionItem ( )

override

Definition at line 381 of file berryCommandContributionItem.cpp.

Member Function Documentation

◆ Fill() [1/2]

void berry::CommandContributionItem::Fill	(	QMenu *	parent,
		QAction *	before
	)

overridevirtual

Fills the given menu with controls representing this contribution item. Used by MenuManager.

Parameters

parent	the parent menu
index	the index where the controls are inserted, or `-1` to insert at the end

Implements berry::IContributionItem.

Definition at line 171 of file berryCommandContributionItem.cpp.

References berry::ContributionItem::STYLE_PULLDOWN, berry::ContributionItem::STYLE_PUSH, and Update().

◆ Fill() [2/2]

void berry::CommandContributionItem::Fill	(	QToolBar *	parent,
		QAction *	before
	)

overridevirtual

Fills the given tool bar with controls representing this contribution item. Used by ToolBarManager.

Parameters

parent	the parent tool bar
index	the index where the controls are inserted, or `-1` to insert at the end

Implements berry::IContributionItem.

Definition at line 217 of file berryCommandContributionItem.cpp.

References Update().

◆ IsEnabled()

bool berry::CommandContributionItem::IsEnabled ( ) const

overridevirtual

Returns whether this contribution item is enabled.

Returns: true if this item is enabled

Implements berry::IContributionItem.

Definition at line 393 of file berryCommandContributionItem.cpp.

Referenced by IsVisible(), and Update().

◆ IsVisible()

bool berry::CommandContributionItem::IsVisible ( ) const

overridevirtual

Returns whether this contribution item is visibile within its manager.

Returns: true if this item is visible, and false otherwise

Implements berry::IContributionItem.

Definition at line 403 of file berryCommandContributionItem.cpp.

References berry::Display::AsyncExec(), display, berry::Display::GetDefault(), berry::ICommandImageService::GetImage(), berry::IServiceLocator::GetService(), berry::Display::InDisplayThread(), IsEnabled(), berry::ContributionItem::IsVisible(), and UpdateCommandPropertiesInUI().

◆ Update() [1/2]

void berry::CommandContributionItem::Update ( )

overridevirtual

Updates any controls cached by this contribution item with any changes which have been made to this contribution item since the last update. Called by contribution manager update methods.

Implements berry::IContributionItem.

Definition at line 247 of file berryCommandContributionItem.cpp.

Referenced by Fill(), and UpdateCommandPropertiesInUI().

◆ Update() [2/2]

void berry::CommandContributionItem::Update ( const QString & id )

overridevirtual

Updates any controls cached by this contribution item with changes for the the given property.

Parameters

id	the id of the changed property

Implements berry::IContributionItem.

Definition at line 252 of file berryCommandContributionItem.cpp.

References BERRY_ERROR, berry::ContributionItem::GetId(), IsEnabled(), and berry::ContributionItem::MODE_FORCE_TEXT.

◆ UpdateCommandPropertiesInUI()

void berry::CommandContributionItem::UpdateCommandPropertiesInUI ( const SmartPointer< const CommandEvent > & commandEvent )

Definition at line 481 of file berryCommandContributionItem.cpp.

References BERRY_ERROR, berry::SmartPointer< TObjectType >::Cast(), berry::ParameterizedCommand::GenerateCommand(), berry::ContributionItem::GetId(), berry::ContributionItem::GetParent(), us::handler, berry::SmartPointer< TObjectType >::IsNull(), berry::WorkbenchPlugin::Log(), berry::ContributionItem::STYLE_CHECK, Update(), and berry::IContributionManager::Update().

Referenced by IsVisible().

Member Data Documentation

◆ modes

ContributionItem::Modes berry::CommandContributionItem::modes

static

Mode bit: Show text on tool items or buttons, even if an image is present. If this mode bit is not set, text is only shown on tool items if there is no image present.

Definition at line 58 of file berryCommandContributionItem.h.

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

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CommandContributionItem()

◆ ~CommandContributionItem()

Member Function Documentation

◆ Fill() [1/2]

◆ Fill() [2/2]

◆ IsEnabled()

◆ IsVisible()

◆ Update() [1/2]

◆ Update() [2/2]

◆ UpdateCommandPropertiesInUI()

Member Data Documentation

◆ modes