#include <berryUIElement.h>

Inheritance diagram for berry::UIElement:

Collaboration diagram for berry::UIElement:

Public Member Functions
	berryObjectMacro (berry::UIElement) virtual void SetText(const QString &text)=0

virtual void	SetToolTip (const QString &text)=0

virtual void	SetIcon (const QIcon &icon)=0

virtual void	SetChecked (bool checked)=0

IServiceLocator *	GetServiceLocator () const

virtual void	SetDropDownId (const QString &id)

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

Protected Member Functions
	UIElement (IServiceLocator *serviceLocator)

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

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 Attributes inherited from berry::Object
QAtomicInt	m_ReferenceCount

QMutex	m_ReferenceCountLock

Detailed Description

Allow a command or application to provide feedback to a user through updating a MenuItem or ToolItem. Initially used to update properties for UI elements created by the CommandContributionItem.

This class may be extended by clients.

Definition at line 40 of file berryUIElement.h.

Constructor & Destructor Documentation

berry::UIElement::UIElement ( IServiceLocator * serviceLocator )

protected

Construct a new instance of this class keyed off of the provided service locator.

Parameters

serviceLocator the locator. May not be null.

Definition at line 24 of file berryUIElement.cpp.

Member Function Documentation

berry::UIElement::berryObjectMacro ( berry::UIElement ) const

pure virtual

Update the label on this UI element.

Parameters

text	The new label to display.

IServiceLocator * berry::UIElement::GetServiceLocator ( ) const

Get the service locator scope in which this UI element resides. May not be null.

The locator may be used to obtain services that are scoped in the same way as the UIElement. Such services include but are not limited to IWorkbench, IWorkbenchWindow, and IWorkbenchPartSite. While this method may not return null requests for any of these particular services may return null.

Returns: the service locator for this element

See also: IServiceLocator::getService(Class)

Definition at line 31 of file berryUIElement.cpp.

virtual void berry::UIElement::SetChecked ( bool checked )

pure virtual

Update the checked state on this UI element. For example, if this was a toggle or radio button.

Parameters

checked true to set toggle on

void berry::UIElement::SetDropDownId ( const QString & id )

virtual

Set the menu contribution id to use. This is only applicable to menu contributions that support a drop-down style menu. The default implementation does nothing.

Example: element.setDropdownId("org.eclipse.ui.navigate.back.my.menu");

Parameters

id	used to populate the dropdown menu. Must not be `null`.

Definition at line 36 of file berryUIElement.cpp.

virtual void berry::UIElement::SetIcon ( const QIcon & icon )

pure virtual

Update the icon on this UI element.

Parameters

icon	The new icon to display.

virtual void berry::UIElement::SetToolTip ( const QString & text )

pure virtual

Update the tooltip on this UI element. Tooltips are currently only valid for toolbar contributions.

Parameters

text	The new tooltip to display.

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation