All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions
Qtilities::CoreGui::Interfaces::ISideViewerWidget Class Reference

Used by the DynamicSideViewerWidget to communicate with child widgets. More...

#include <ISideViewerWidget.h>

Inheritance diagram for Qtilities::CoreGui::Interfaces::ISideViewerWidget:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual IActionProvideractionProvider () const =0
 Provides an action provider interface to provide actions to be shown in the SideWidgetWrapper class.
virtual QList< int > destinationModes () const =0
 Indication of the modes (which have dynamic side viewer widgets) in which the side viewer may appear.
virtual bool isExclusive () const =0
 Indicates if the widget is exclusive.
virtual bool manageWidgets () const =0
 When true, the dynamic side viewer widget will manage the lifetime of widgets returned through produceWidget().
virtual QWidget * produceWidget ()=0
 Function which returns the side viewer widget.
virtual QList< int > startupModes () const =0
 Indicates if the widget should be shown on startup.
virtual QString widgetLabel () const =0
 The text used to represent the widget.
- Public Member Functions inherited from Qtilities::Core::Interfaces::IObjectBase
virtual QObject * objectBase ()=0
 Returns the QObject* base of the interface.
virtual const QObject * objectBase () const =0
 Returns a const QObject* base of the interface.
QString objectOriginID () const
 Allows interfaces to provide some sort of source identification.
void setObjectOriginID (const QString &object_origin_id)
 Allows setting of the object source ID of this interface implementation.

Detailed Description

Used by the DynamicSideViewerWidget to communicate with child widgets.


Member Function Documentation

virtual bool Qtilities::CoreGui::Interfaces::ISideViewerWidget::isExclusive ( ) const
pure virtual

Indicates if the widget is exclusive.

When true, this widget can only appear once inside a dynamic side widget viewer.

Note:
When true this side viewer widget can only be used with a Qtilities::CoreGui::DynamicSideWidgetViewer which is set to be exclusive. When the mode(s) specified in destinationModes() is not for an exclusive viewer widget, an error message will be printed.

Implemented in Qtilities::CoreGui::SideViewerWidgetFactory, Qtilities::Plugins::Help::ContentWidgetFactory, Qtilities::Plugins::Help::IndexWidgetFactory, and Qtilities::Plugins::Help::SearchWidgetFactory.

virtual QWidget* Qtilities::CoreGui::Interfaces::ISideViewerWidget::produceWidget ( )
pure virtual

Function which returns the side viewer widget.

Widget() must be able to produce a new widget every time it is called. The Qtilities::CoreGui::SideViewerWidgetFactory class was designed to help with this process.

The dynamic side viewer widget will manage the lifetime of widgets returned.

Implemented in Qtilities::CoreGui::SideViewerWidgetFactory, Qtilities::Plugins::Help::ContentWidgetFactory, Qtilities::Plugins::Help::IndexWidgetFactory, and Qtilities::Plugins::Help::SearchWidgetFactory.



Qtilities : Reference Documentation Back to top Copyright © 2009-2013, Jaco Naudé