VR-Forces 5.0.2 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes
makVrf::DtAutoHidePanel Class Reference

This class implements the panel where auto hide dialogs are placed when they are hidden. This panel is located on the right side of the app.

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

Public Types

enum  DtAppearanceOptions { Hidden = 0, Pinned, Docked, Floating }
 
typedef std::list
< DtAutoHidePanelItem * > 		DtAutoHidePanelItemList
 
typedef
DtAutoHidePanelItemList::iterator 		DtAutoHidePanelItemListIterator
 
typedef std::list
< DtAutoHideDock * > 		DtAutoHideDockList
 
typedef
DtAutoHideDockList::iterator 		DtAutoHideDockListIterator
 
typedef std::map< std::string,
DtAppearanceOptions > 		DtAppearanceList
 
typedef std::map< std::string,
DtAppearanceOptions >
::iterator 		DtAppearanceListIterator
 
- Public Types inherited from makVrv::DtQtPageCollection
typedef boost::unordered_map
< std::string, DtPage * > 		PageMap
 
- Public Types inherited from makVrv::DtPageCollection
typedef std::vector< std::string > PageClassList
 

Public Member Functions

 DtAutoHidePanel (makVrv::DtDe &de, const std::string &name, makVrv::DtQtDeMainWindow *parent)
 
virtual ~DtAutoHidePanel ()
 
virtual DtAutoHidePanelItem * addItem (DtAutoHideDock *dock, bool forceVisible=false, bool initiallVisible=true)
 
virtual void clear ()
 
virtual DtAutoHidePanelItem * findItemForClass (const std::string &s)
 
virtual DtAutoHidePanelItem * findItemForDock (const DtAutoHideDock *dock)
 
virtual void setPanelItemVisible (const std::string &panelClassName, bool, bool updateVisibilityState=false)
 
virtual void hideAllDocks ()
 
virtual int itemCount ()
 
virtual void placeItems ()
 
virtual void removeItem (DtAutoHidePanelItem *item)
 
virtual void showDockForItem (DtAutoHidePanelItem *item, bool animate=true)
 
virtual void hideDockForItem (DtAutoHidePanelItem *item, bool animate=true)
 
virtual std::vector< std::pair
< DtString, QString > > 		panelsThatCanBeUsedOnCreateMenu () const
 
virtual void changeVisibility (bool)
 
virtual bool findDock (DtAutoHideDock *dock)
 
virtual void changeLocation (makVrv::DtPageConfiguration::PageCollectionLocation)
 
virtual void changeFloatingGeometry (int px, int py, int width, int height)
 
virtual void changeFloatingGeometry (const makVrv::DtPageConfiguration::PageCollectionGeometry &geometry)
 
virtual void changeDockedGeometry (int px, int py, int width, int height)
 
virtual void changeDockedGeometry (const makVrv::DtPageConfiguration::PageCollectionGeometry &geometry)
 
virtual void selectPage (const std::string &pageClassName)
 
const DtAutoHideDockList & docks () const
 
template<typename PaletteClass >
PaletteClass * createPalette ()
 
template<typename PaletteClass >
DtAutoHideDock * creationDock ()
 
virtual DtEntityCreatePalette * entityCreatePalette ()
 
virtual DtAutoHideDock * entityCreationDock ()
 
virtual
DtTacticalGraphicCreatePalette * 		tacticalGraphicCreatePalette ()
 
virtual DtAutoHideDock * tacticalGraphicCreationDock ()
 
virtual DtPropCreatePalette * propCreatePalette ()
 
virtual DtAutoHideDock * propCreationDock ()
 
virtual void setItemPinned (DtAutoHidePanelItem *, bool)
 
virtual int maxItemWidth ()
 
- Public Member Functions inherited from makVrv::DtQtPageCollection
 DtQtPageCollection (DtDe &de, const std::string &collectionClassName)
 
virtual ~DtQtPageCollection ()
 
void addPage (DtPage *page)
 
void removePage (DtPage *page, bool deletePage=true)
 
DtPage * findPage (const std::string &pageClassName)
 
const DtPage * findPage (const std::string &pageClassName) const
 
const PageMap & pages () const
 
virtual void removeContainer ()
 
virtual void bringToTop ()
 
- Public Member Functions inherited from makVrv::DtPageCollection
 DtPageCollection (DtDe &de, const std::string &collectionClassName)
 
virtual ~DtPageCollection ()
 
const std::string & collectionClassName () const
 
const PageClassList & pageClasses () const
 
void show (const std::string &page=std::string(""))
 
void hide ()
 
bool visible () const
 
virtual int tabIndex () const
 
virtual bool isTabbed () const
 
DtPageConfiguration::PageCollectionLocation location () const
 
void setLocation (DtPageConfiguration::PageCollectionLocation location)
 
DtPageConfiguration::PageCollectionGeometry & floatingGeometry ()
 
void setFloatingGeometry (const DtPageConfiguration::PageCollectionGeometry &geometry)
 
void setFloatingGeometry (int px, int py, int width, int height)
 
virtual
DtPageConfiguration::PageCollectionGeometry 		dockedGeometry ()
 
void setDockedGeometry (const DtPageConfiguration::PageCollectionGeometry &geometry)
 
void setDockedGeometry (int px, int py, int width, int height)
 
- Public Member Functions inherited from makVrv::DtVirtualBaseClass
 DtVirtualBaseClass ()
 
virtual ~DtVirtualBaseClass ()
 

Static Public Member Functions

static DtAutoHidePanel * instance (makVrv::DtDe &)
 

Protected Slots

virtual void slot_onItemToggled (DtAutoHidePanelItem *)
 
virtual void slot_onItemClicked (DtAutoHidePanelItem *)
 
virtual void slot_dockClosed (DtAutoHideDock *dockWidget)
 
virtual void slot_dockEntered (DtAutoHideDock *dockWidget)
 
virtual void slot_dockLeft (DtAutoHideDock *dockWidget)
 
virtual void slot_dockResized (DtAutoHideDock *dockWidget)
 
virtual void slot_dockDestroyed (DtAutoHideDock *dockWidget)
 
virtual void slot_showDockOfCurrentItem (bool lockIt=false)
 
virtual void slot_closeTimerTimeout ()
 
virtual void slot_onItemAvailabilityChanged (DtAutoHidePanelItem *dockWidget)
 
virtual void slot_observerModeSettingChanged (makVrv::DtObserverObject *, int setting, bool value)
 
virtual void placeCompass ()
 
virtual void finalizeSetup ()
 

Protected Member Functions

virtual void setupGui ()
 
virtual bool eventFilter (QObject *p, QEvent *e)
 
virtual void installEventFilters ()
 
virtual void removeDock (DtAutoHideDock *dock)
 
virtual void relocateAnyPinnedDock ()
 
virtual void refreshItems (int minsize)
 
virtual void refreshAppearanceOfItem (DtAutoHidePanelItem *autoHideItemWidget, bool forceVisible)
 
virtual void addPageToGui (makVrv::DtPage *)
 
virtual void removePageFromGui (makVrv::DtPage *)
 
virtual void selectPageInGui (makVrv::DtPage *page)
 
- Protected Member Functions inherited from makVrv::DtQtPageCollection
virtual void activatePage (DtPage *)
 
virtual void deactivatePage (DtPage *)
 
- Protected Member Functions inherited from makVrv::DtPageCollection
void addPageClass (const std::string &pageClassName)
 
void removePageClass (const std::string &pageClassName)
 

Protected Attributes

QMainWindow * myMainWindow
 
QWidget * myCentralWidget
 
DtAutoHidePanelItemList myItems
 
DtAutoHideDockList myDocks
 
DtAppearanceList myItemsAppearance
 
DtWidgetAnimator * myWidgetAnimator
 
DtAutoHidePanelItem * myCurrentItem
 
DtAutoHidePanelItem * myDockToClose
 
QTimer myTimer
 
QTimer myCloseTimer
 
makVrv::DtSignalConnectionManager myConnections
 
DtAutoHideDock * myCloseIfMousePressOutside
 
- Protected Attributes inherited from makVrv::DtQtPageCollection
PageMap myPages
 
- Protected Attributes inherited from makVrv::DtPageCollection
DtDe & myDe
 
std::string myClassName
 
bool myVisibility
 
PageClassList myPageClasses
 
DtPageConfiguration::PageCollectionLocation myLocation
 
DtPageConfiguration::PageCollectionGeometry myFloatingGeometry
 
DtPageConfiguration::PageCollectionGeometry myDockedGeometry
 

Additional Inherited Members

- Public Attributes inherited from makVrv::DtPageCollection
boost::signalslib::signal< void()> signal_shown
 
boost::signalslib::signal< void()> signal_hidden
 
boost::signalslib::signal
< void(const std::string &)> 		signal_pageSelected
 

Member Typedef Documentation

typedef std::list<DtAutoHidePanelItem*> makVrf::DtAutoHidePanel::DtAutoHidePanelItemList
typedef DtAutoHidePanelItemList::iterator makVrf::DtAutoHidePanel::DtAutoHidePanelItemListIterator
typedef std::list<DtAutoHideDock*> makVrf::DtAutoHidePanel::DtAutoHideDockList
typedef DtAutoHideDockList::iterator makVrf::DtAutoHidePanel::DtAutoHideDockListIterator
typedef std::map<std::string, DtAppearanceOptions> makVrf::DtAutoHidePanel::DtAppearanceList
typedef std::map<std::string, DtAppearanceOptions>::iterator makVrf::DtAutoHidePanel::DtAppearanceListIterator

Member Enumeration Documentation

enum makVrf::DtAutoHidePanel::DtAppearanceOptions
Enumerator
Hidden 
Pinned 
Docked 
Floating 

Constructor & Destructor Documentation

makVrf::DtAutoHidePanel::DtAutoHidePanel ( makVrv::DtDe &  de,
const std::string &  name,
makVrv::DtQtDeMainWindow *  parent 
)
virtual makVrf::DtAutoHidePanel::~DtAutoHidePanel ( )
virtual

Member Function Documentation

virtual DtAutoHidePanelItem* makVrf::DtAutoHidePanel::addItem ( DtAutoHideDock *  dock,
bool  forceVisible = false,
bool  initiallVisible = true 
)
virtual

Registers the dock to be managed by the panel. When added the dock is hidden by default. Use the forceVisible flag to tell the panel to force the panel to be shown after adding it.

virtual void makVrf::DtAutoHidePanel::clear ( )
virtual

Removes all the items from the panel.

virtual DtAutoHidePanelItem* makVrf::DtAutoHidePanel::findItemForClass ( const std::string &  s)
virtual
virtual DtAutoHidePanelItem* makVrf::DtAutoHidePanel::findItemForDock ( const DtAutoHideDock *  dock)
virtual
virtual void makVrf::DtAutoHidePanel::setPanelItemVisible ( const std::string &  panelClassName,
bool  ,
bool  updateVisibilityState = false 
)
virtual

Sets the particular panel item to be visible or not. If updateVisibilityState is true, also update in layout manager.

virtual void makVrf::DtAutoHidePanel::hideAllDocks ( )
virtual

Hides all the dialogs on display for any of the items, as long as the item is not marked as pinned.

virtual int makVrf::DtAutoHidePanel::itemCount ( )
virtual

Returns the total of items currently in the panel.

virtual void makVrf::DtAutoHidePanel::placeItems ( )
virtual

Displays all the items of the panel.

virtual void makVrf::DtAutoHidePanel::removeItem ( DtAutoHidePanelItem *  item)
virtual

Removes the given item from the panel.

virtual void makVrf::DtAutoHidePanel::showDockForItem ( DtAutoHidePanelItem *  item,
bool  animate = true 
)
virtual

Shows the dock associated with the given item.

virtual void makVrf::DtAutoHidePanel::hideDockForItem ( DtAutoHidePanelItem *  item,
bool  animate = true 
)
virtual

Hides the dock associated with the item only if the item is not pinned.

static DtAutoHidePanel* makVrf::DtAutoHidePanel::instance ( makVrv::DtDe &  )
static

Returns this instance.

virtual std::vector< std::pair<DtString, QString> > makVrf::DtAutoHidePanel::panelsThatCanBeUsedOnCreateMenu ( ) const
virtual

Returns a list of panels (keyword/title) that can be used on a create menu. Currently these are only subclasses of DtEntityCreatePalette.

virtual void makVrf::DtAutoHidePanel::changeVisibility ( bool  newVisibility)
virtual

Implement the visibility change of the widget.

Implements makVrv::DtPageCollection.

virtual bool makVrf::DtAutoHidePanel::findDock ( DtAutoHideDock *  dock)
virtual
virtual void makVrf::DtAutoHidePanel::changeLocation ( makVrv::DtPageConfiguration::PageCollectionLocation  )
inlinevirtual

No-op. Cannot change location or geometry.

Implement changing the location of the collection

Implements makVrv::DtPageCollection.

virtual void makVrf::DtAutoHidePanel::changeFloatingGeometry ( int  px,
int  py,
int  width,
int  height 
)
inlinevirtual

Implement changing the floating geometry of the collection.

Implements makVrv::DtPageCollection.

virtual void makVrf::DtAutoHidePanel::changeFloatingGeometry ( const makVrv::DtPageConfiguration::PageCollectionGeometry &  geometry)
inlinevirtual

Implement changing the floating geometry of the collection.

Implements makVrv::DtPageCollection.

virtual void makVrf::DtAutoHidePanel::changeDockedGeometry ( int  px,
int  py,
int  width,
int  height 
)
inlinevirtual

Implement changing the docked geometry of the collection.

Implements makVrv::DtPageCollection.

virtual void makVrf::DtAutoHidePanel::changeDockedGeometry ( const makVrv::DtPageConfiguration::PageCollectionGeometry &  geometry)
inlinevirtual

Implement changing the docked geometry of the collection.

Implements makVrv::DtPageCollection.

virtual void makVrf::DtAutoHidePanel::selectPage ( const std::string &  pageClassName)
inlinevirtual

Implement selecting a page by name.

Reimplemented from makVrv::DtQtPageCollection.

const DtAutoHideDockList& makVrf::DtAutoHidePanel::docks ( ) const
inline
template<typename PaletteClass >
PaletteClass* makVrf::DtAutoHidePanel::createPalette ( )
inline
template<typename PaletteClass >
DtAutoHideDock* makVrf::DtAutoHidePanel::creationDock ( )
inline
virtual DtEntityCreatePalette* makVrf::DtAutoHidePanel::entityCreatePalette ( )
inlinevirtual

Return the entity create palette.

virtual DtAutoHideDock* makVrf::DtAutoHidePanel::entityCreationDock ( )
inlinevirtual
virtual DtTacticalGraphicCreatePalette* makVrf::DtAutoHidePanel::tacticalGraphicCreatePalette ( )
inlinevirtual

Return the tactical graphic create palette.

virtual DtAutoHideDock* makVrf::DtAutoHidePanel::tacticalGraphicCreationDock ( )
inlinevirtual
virtual DtPropCreatePalette* makVrf::DtAutoHidePanel::propCreatePalette ( )
inlinevirtual

Return the prop create palette.

virtual DtAutoHideDock* makVrf::DtAutoHidePanel::propCreationDock ( )
inlinevirtual
virtual void makVrf::DtAutoHidePanel::setItemPinned ( DtAutoHidePanelItem *  ,
bool   
)
virtual

Sets whether or not the item is pinned. If not visible when pinned is true will show item.

virtual int makVrf::DtAutoHidePanel::maxItemWidth ( )
virtual
virtual void makVrf::DtAutoHidePanel::setupGui ( )
protectedvirtual

Initializes the GUI for the panel.

virtual bool makVrf::DtAutoHidePanel::eventFilter ( QObject *  p,
QEvent *  e 
)
protectedvirtual
virtual void makVrf::DtAutoHidePanel::installEventFilters ( )
protectedvirtual
virtual void makVrf::DtAutoHidePanel::removeDock ( DtAutoHideDock *  dock)
protectedvirtual
virtual void makVrf::DtAutoHidePanel::relocateAnyPinnedDock ( )
protectedvirtual
virtual void makVrf::DtAutoHidePanel::refreshItems ( int  minsize)
protectedvirtual
virtual void makVrf::DtAutoHidePanel::refreshAppearanceOfItem ( DtAutoHidePanelItem *  autoHideItemWidget,
bool  forceVisible 
)
protectedvirtual
virtual void makVrf::DtAutoHidePanel::addPageToGui ( makVrv::DtPage *  )
protectedvirtual

Implement adding the page to the GUI.

Implements makVrv::DtQtPageCollection.

virtual void makVrf::DtAutoHidePanel::removePageFromGui ( makVrv::DtPage *  )
protectedvirtual

Implement removing a page from the GUI.

Implements makVrv::DtQtPageCollection.

virtual void makVrf::DtAutoHidePanel::selectPageInGui ( makVrv::DtPage *  page)
inlineprotectedvirtual

Implement selecting a page in the GUI.

Implements makVrv::DtQtPageCollection.

virtual void makVrf::DtAutoHidePanel::slot_onItemToggled ( DtAutoHidePanelItem *  )
protectedvirtualslot

This slot is executed when the mouse is pressed over any item of the panel.

virtual void makVrf::DtAutoHidePanel::slot_onItemClicked ( DtAutoHidePanelItem *  )
protectedvirtualslot

This slot is executed when the mouse is pressed over any item of the panel.

virtual void makVrf::DtAutoHidePanel::slot_dockClosed ( DtAutoHideDock *  dockWidget)
protectedvirtualslot
virtual void makVrf::DtAutoHidePanel::slot_dockEntered ( DtAutoHideDock *  dockWidget)
protectedvirtualslot
virtual void makVrf::DtAutoHidePanel::slot_dockLeft ( DtAutoHideDock *  dockWidget)
protectedvirtualslot
virtual void makVrf::DtAutoHidePanel::slot_dockResized ( DtAutoHideDock *  dockWidget)
protectedvirtualslot
virtual void makVrf::DtAutoHidePanel::slot_dockDestroyed ( DtAutoHideDock *  dockWidget)
protectedvirtualslot
virtual void makVrf::DtAutoHidePanel::slot_showDockOfCurrentItem ( bool  lockIt = false)
protectedvirtualslot
virtual void makVrf::DtAutoHidePanel::slot_closeTimerTimeout ( )
protectedvirtualslot
virtual void makVrf::DtAutoHidePanel::slot_onItemAvailabilityChanged ( DtAutoHidePanelItem *  dockWidget)
protectedvirtualslot
virtual void makVrf::DtAutoHidePanel::slot_observerModeSettingChanged ( makVrv::DtObserverObject *  ,
int  setting,
bool  value 
)
protectedvirtualslot
virtual void makVrf::DtAutoHidePanel::placeCompass ( )
protectedvirtualslot
virtual void makVrf::DtAutoHidePanel::finalizeSetup ( )
protectedvirtualslot

Member Data Documentation

QMainWindow* makVrf::DtAutoHidePanel::myMainWindow
protected
QWidget* makVrf::DtAutoHidePanel::myCentralWidget
protected
DtAutoHidePanelItemList makVrf::DtAutoHidePanel::myItems
protected
DtAutoHideDockList makVrf::DtAutoHidePanel::myDocks
protected

List with all the items currently on display.

DtAppearanceList makVrf::DtAutoHidePanel::myItemsAppearance
protected

List with all the docks registered with this panel.

DtWidgetAnimator* makVrf::DtAutoHidePanel::myWidgetAnimator
protected

Keeps track of the last appearance of the items (hidden, pinned, docked, floating)

DtAutoHidePanelItem* makVrf::DtAutoHidePanel::myCurrentItem
protected

Animates the display of a dock.

DtAutoHidePanelItem* makVrf::DtAutoHidePanel::myDockToClose
protected

Current item to be shown.

QTimer makVrf::DtAutoHidePanel::myTimer
protected

The item that wants to be closed.

QTimer makVrf::DtAutoHidePanel::myCloseTimer
protected

Controls the 1 second delay before showing a dock.

makVrv::DtSignalConnectionManager makVrf::DtAutoHidePanel::myConnections
protected

Controls the 1 second delay before hiding a dock.

DtAutoHideDock* makVrf::DtAutoHidePanel::myCloseIfMousePressOutside
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Sun Dec 4 20:22:03 EST 2022 from SVN revision 249613
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)