INavigationWidgetFactory Class
class Core::INavigationWidgetFactoryThe INavigationWidgetFactory class provides new instances of navigation widgets. More...
Header: | #include <coreplugin/inavigationwidgetfactory.h> |
Inherits: | QObject |
Public Functions
INavigationWidgetFactory() | |
QKeySequence | activationSequence() const |
virtual Core::NavigationView | createWidget() = 0 |
QString | displayName() const |
Utils::Id | id() const |
int | priority() const |
virtual void | restoreSettings(Utils::QtcSettings *settings, int position, QWidget *widget) |
virtual void | saveSettings(Utils::QtcSettings *settings, int position, QWidget *widget) |
void | setActivationSequence(const QKeySequence &keys) |
void | setDisplayName(const QString &displayName) |
void | setId(Utils::Id id) |
void | setPriority(int priority) |
Detailed Description
A navigation widget factory is necessary because there can be more than one navigation widget of the same type at a time. Each navigation widget is wrapped in a Core::NavigationView for delivery.
Member Function Documentation
INavigationWidgetFactory::INavigationWidgetFactory()
Constructs a navigation widget factory.
QKeySequence INavigationWidgetFactory::activationSequence() const
Returns the keyboard shortcut to activate an instance of a navigation widget.
See also setActivationSequence().
[pure virtual]
Core::NavigationView INavigationWidgetFactory::createWidget()
Returns a Core::NavigationView containing the widget and the buttons. The ownership is given to the caller.
QString INavigationWidgetFactory::displayName() const
Returns the display name of the navigation widget, which is shown in the dropdown menu above the navigation widget.
See also setDisplayName().
Utils::Id INavigationWidgetFactory::id() const
Returns a unique identifier for referencing the navigation widget factory.
See also setId().
int INavigationWidgetFactory::priority() const
Determines the position of the navigation widget in the dropdown menu.
0 to 1000 from top to bottom
See also setPriority().
[virtual]
void INavigationWidgetFactory::restoreSettings(Utils::QtcSettings *settings, int position, QWidget *widget)
Reads and restores the settings for the widget at position that was created by this factory (the position identifies a specific navigation widget).
See also INavigationWidgetFactory::saveSettings().
[virtual]
void INavigationWidgetFactory::saveSettings(Utils::QtcSettings *settings, int position, QWidget *widget)
Stores the settings for the widget at position that was created by this factory (the position identifies a specific navigation widget).
See also INavigationWidgetFactory::restoreSettings().
void INavigationWidgetFactory::setActivationSequence(const QKeySequence &keys)
Sets the keyboard activation sequence for the factory to keys.
See also activationSequence().
void INavigationWidgetFactory::setDisplayName(const QString &displayName)
Sets the display name for the factory to displayName.
See also displayName().
void INavigationWidgetFactory::setId(Utils::Id id)
Sets the id for the factory.
See also id().
void INavigationWidgetFactory::setPriority(int priority)
Sets the priority for the factory.
See also priority().