VR-Forces 4.3.1 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions | Public Attributes
makVrf::DtExtendedDockable Class Reference

A widget class for managing simulation back-ends. More...

Inheritance diagram for makVrf::DtExtendedDockable:
Inheritance graph
[legend]

Public Member Functions

 DtExtendedDockable (makVrv::DtDe &de, const std::string &className)
 CTOR.
virtual ~DtExtendedDockable ()
 DTOR.
virtual void dock (makVrv::DtQtDeMainWindow &mainWindow, Qt::DockWidgetArea area)
virtual void showContainer ()
 Show the container.
virtual void hideContainer ()
 Hide the container.
virtual QPixmap shadowIcon () const =0
 Returns the icon that will be used for the mouse over.
virtual QString iconName () const =0
 Returns the "short name" that will be placed next to the icon.
- Public Member Functions inherited from makVrv::DtDockable
 DtDockable (DtDe &de, const std::string &className)
 CTOR By default a dockable widget is not docked, call dock to attempt to dock this widget.
virtual ~DtDockable ()
 DTOR.
const std::string & className () const
 The class name.
void dock (Qt::DockWidgetArea area)
 Dock this dockable in the main window, this function should only be called once.
virtual bool isDocked () const
 Check to see if we are in a container.
virtual void setContainerVisible (bool visible)
 call either shows or hides container base upon the input.
virtual void setContainerMovable (bool moveable)
 Set whether the container is moveable.
virtual void setContainerFloatable (bool floatable)
 Set whether the container is floatable.
virtual void setContainerClosable (bool closeable)
 Set whether the container is closeable.
virtual bool isContainerHidden () const
 Returns true if container is hidden.
virtual bool isContainerMovable () const
 Returns true if container is moveable.
virtual bool isContainerFloatable () const
 Returns true if container is floatable.
virtual bool isContainerClosable () const
 Returns true if container is closeable.
virtual void floatContainer ()
 Float the container.
virtual void unfloatContainer ()
 Un float the container.
virtual void removeContainer ()
 Untabs the container.
virtual bool initiallyVisible () const
 Virtual function needed for controlling if the widget is docked visible.
virtual Qt::DockWidgetArea initialDockWidgetLocation () const
 Virtual function needed for controlling if the widget is docked visible.
virtual bool containerTabbed () const
 Tells whether the container is tabbed or not.
virtual int containerTabIndex () const
 If the container is tabbed, returns the position of the container inside the tab structure.
virtual void getContainerTabbedGeometry (int &x, int &y, int &width, int &height) const
 Gets the geometry of the container if it is tabbed.
virtual QWidgetcontainer ()
 Returns the QDockWidget or other container that holds this widget.
virtual void setContainer (QWidget *cont)
 Set with the QDockWidget or other container that holds this widget.
virtual void bringToTop ()
 Brings the container to the front (when it is tabbed)
virtual void setDockWidgetItem (DtDockWidgetItem *item)
 If this dockable is the target of a menu item, a pointer to to the associated menu item.
virtual DtDockWidgetItemdockWidgetItem () const
 Get the associated menu item, if any.
virtual void connectContainerToDockItem ()
 The menu item create does this the first time, but we need to do it explicitly on GUI restores.

Public Attributes

boost::signal< void()> signal_contentsModified
 Send this signal when the contents are modified and the "little" expandable icon wants to be updated.

Additional Inherited Members

- Protected Member Functions inherited from makVrv::DtDockable
QTabBartabBar () const
 Returns the container tab bar object if myContainer is tabbed.
- Protected Attributes inherited from makVrv::DtDockable
QWidgetmyContainer
 my Container widget
std::string myClassName
DtDemyDe
bool myIsFloatable
bool myIsClosable
bool myIsMovable
DtDockWidgetItemmyDockWidgetItem

Detailed Description

A widget class for managing simulation back-ends.

Constructor & Destructor Documentation

makVrf::DtExtendedDockable::DtExtendedDockable ( makVrv::DtDe de,
const std::string &  className 
)

CTOR.

virtual makVrf::DtExtendedDockable::~DtExtendedDockable ( )
virtual

DTOR.

Member Function Documentation

virtual void makVrf::DtExtendedDockable::dock ( makVrv::DtQtDeMainWindow mainWindow,
Qt::DockWidgetArea  area 
)
virtual
virtual void makVrf::DtExtendedDockable::showContainer ( )
virtual

Show the container.

Reimplemented from makVrv::DtDockable.

virtual void makVrf::DtExtendedDockable::hideContainer ( )
virtual

Hide the container.

Reimplemented from makVrv::DtDockable.

virtual QPixmap makVrf::DtExtendedDockable::shadowIcon ( ) const
pure virtual

Returns the icon that will be used for the mouse over.

If this returns a NULL icon the dock widget will be used as the template

virtual QString makVrf::DtExtendedDockable::iconName ( ) const
pure virtual

Returns the "short name" that will be placed next to the icon.

Member Data Documentation

boost::signal<void ()> makVrf::DtExtendedDockable::signal_contentsModified

Send this signal when the contents are modified and the "little" expandable icon wants to be updated.


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

Document ID: Generated on Wed Jul 29 00:55:00 EDT 2015 from SVN revision 155257
Copyright © 2005-2015 VT MÄK. All Rights Reserved (www.mak.com)