makVrf::DtAutoHidePanel Class Reference

This class implements the panel where auto hide dialogs are placed when they are hidden. More...

Inheritance diagram for makVrf::DtAutoHidePanel:

List of all members.

Public Types
enum	DtAppearanceOptions { Hidden = 0, Pinned, Docked, Floating }
typedef std::list < DtAutoHidePanelItem * >	DtAutoHidePanelItemList
typedef std::list < DtAutoHidePanelItem * > ::iterator	DtAutoHidePanelItemListIterator
typedef std::list < DtAutoHideDock * >	DtAutoHideDockList
typedef std::list < DtAutoHideDock * >::iterator	DtAutoHideDockListIterator
typedef std::map< std::string, DtAppearanceOptions >	DtAppearanceList
typedef std::map< std::string, DtAppearanceOptions > ::iterator	DtAppearanceListIterator
Public Member Functions
	DtAutoHidePanel (makVrv::DtDe &de, makVrv::DtQtDeMainWindow *parent)
	~DtAutoHidePanel ()
virtual void	addItem (DtAutoHideDock *dock, bool forceVisible=false)
	Registers the dock to be managed by the panel.
virtual void	clear ()
	Removes all the items from the panel.
virtual DtAutoHidePanelItem *	findItemForDock (const DtAutoHideDock *dock)
virtual void	hideAllDocks ()
	Hides all the dialogs on display for any of the items, as long as the item is not marked as pinned.
virtual int	itemCount ()
	Returns the total of items currently in the panel.
virtual void	placeItems ()
	Displays all the items of the panel.
virtual void	removeItem (DtAutoHidePanelItem *item)
	Removes the given item from the panel.
virtual void	showDockForItem (DtAutoHidePanelItem *item, bool animate=true)
	Shows the dock associated with the given item.
virtual void	hideDockForItem (DtAutoHidePanelItem *item, bool animate=true)
	Hides the dock associated with the item only if the item is not pinned.
virtual DtEntityCreatePalette *	entityCreatePalette ()
	Return the entity create palette.
virtual DtPropCreatePalette *	propCreatePalette ()
	Return the prop create palette.
Static Public Member Functions
static DtAutoHidePanel *	instance (makVrv::DtDe &)
	Returns this instance.
Protected Slots
virtual void	slot_onItemToggled (DtAutoHidePanelItem *)
	This slot is executed when the mouse is pressed over any item of the panel.
virtual void	slot_onItemClicked (DtAutoHidePanelItem *)
	This slot is executed when the mouse is pressed over any item of the panel.
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 ()
	Initializes the GUI for the panel.
virtual bool	eventFilter (QObject *p, QEvent *e)
virtual void	installEventFilters ()
virtual int	maxItemWidth ()
virtual int	findDock (const DtAutoHideDock *dock)
virtual void	removeDock (DtAutoHideDock *dock)
virtual void	relocateAnyPinnedDock ()
virtual void	refreshItems (int minsize)
virtual void	refreshAppearanceOfItem (DtAutoHidePanelItem *autoHideItemWidget, bool forceVisible)
Protected Attributes
makVrv::DtDe &	myDe
QMainWindow *	myMainWindow
QWidget *	myCentralWidget
DtAutoHidePanelItemList	myItems
DtAutoHideDockList	myDocks
	List with all the items currently on display.
DtAppearanceList	myItemsAppearance
	List with all the docks registered with this panel.
DtWidgetAnimator *	myWidgetAnimator
	Keeps track of the last appearance of the items (hidden, pinned, docked, floating)
DtAutoHidePanelItem *	myCurrentItem
	Animates the display of a dock.
QTimer	myTimer
	Current item to be shown.
QTimer	myCloseTimer
	Controls the 1 second delay before showing a dock.
makVrv::DtSignalConnectionManager	myConnections
	Controls the 1 second delay before hiding a dock.

---

Detailed Description

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.

---

Member Typedef Documentation

typedef std::list<DtAutoHidePanelItem*> makVrf::DtAutoHidePanel::DtAutoHidePanelItemList

typedef std::list<DtAutoHidePanelItem*>::iterator makVrf::DtAutoHidePanel::DtAutoHidePanelItemListIterator

typedef std::list<DtAutoHideDock*> makVrf::DtAutoHidePanel::DtAutoHideDockList

typedef std::list<DtAutoHideDock*>::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,
		makVrv::DtQtDeMainWindow *	parent
	)

makVrf::DtAutoHidePanel::~DtAutoHidePanel

(

)

---

Member Function Documentation

virtual void makVrf::DtAutoHidePanel::addItem	(	DtAutoHideDock *	dock,
		bool	forceVisible = false
	)		[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::findItemForDock

(

const DtAutoHideDock *

dock

)

[virtual]

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 DtEntityCreatePalette* makVrf::DtAutoHidePanel::entityCreatePalette

(

)

[virtual]

Return the entity create palette.

virtual DtPropCreatePalette* makVrf::DtAutoHidePanel::propCreatePalette

(

)

[virtual]

Return the prop create palette.

virtual void makVrf::DtAutoHidePanel::setupGui

(

)

[protected, virtual]

Initializes the GUI for the panel.

virtual bool makVrf::DtAutoHidePanel::eventFilter	(	QObject *	p,
		QEvent *	e
	)		[protected, virtual]

virtual void makVrf::DtAutoHidePanel::installEventFilters

(

)

[protected, virtual]

virtual int makVrf::DtAutoHidePanel::maxItemWidth

(

)

[protected, virtual]

virtual int makVrf::DtAutoHidePanel::findDock

(

const DtAutoHideDock *

dock

)

[protected, virtual]

virtual void makVrf::DtAutoHidePanel::removeDock

(

DtAutoHideDock *

dock

)

[protected, virtual]

virtual void makVrf::DtAutoHidePanel::relocateAnyPinnedDock

(

)

[protected, virtual]

virtual void makVrf::DtAutoHidePanel::refreshItems

(

int

minsize

)

[protected, virtual]

virtual void makVrf::DtAutoHidePanel::refreshAppearanceOfItem	(	DtAutoHidePanelItem *	autoHideItemWidget,
		bool	forceVisible
	)		[protected, virtual]

virtual void makVrf::DtAutoHidePanel::slot_onItemToggled

(

DtAutoHidePanelItem *

)

[protected, virtual, slot]

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

virtual void makVrf::DtAutoHidePanel::slot_onItemClicked

(

DtAutoHidePanelItem *

)

[protected, virtual, slot]

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

virtual void makVrf::DtAutoHidePanel::slot_dockClosed

(

DtAutoHideDock *

dockWidget

)

[protected, virtual, slot]

virtual void makVrf::DtAutoHidePanel::slot_dockEntered

(

DtAutoHideDock *

dockWidget

)

[protected, virtual, slot]

virtual void makVrf::DtAutoHidePanel::slot_dockLeft

(

DtAutoHideDock *

dockWidget

)

[protected, virtual, slot]

virtual void makVrf::DtAutoHidePanel::slot_dockResized

(

DtAutoHideDock *

dockWidget

)

[protected, virtual, slot]

virtual void makVrf::DtAutoHidePanel::slot_dockDestroyed

(

DtAutoHideDock *

dockWidget

)

[protected, virtual, slot]

virtual void makVrf::DtAutoHidePanel::slot_showDockOfCurrentItem

(

bool

lockIt = false

)

[protected, virtual, slot]

virtual void makVrf::DtAutoHidePanel::slot_closeTimerTimeout

(

)

[protected, virtual, slot]

virtual void makVrf::DtAutoHidePanel::slot_onItemAvailabilityChanged

(

DtAutoHidePanelItem *

dockWidget

)

[protected, virtual, slot]

virtual void makVrf::DtAutoHidePanel::slot_observerModeSettingChanged	(	makVrv::DtObserverObject *	,
		int	setting,
		bool	value
	)		[protected, virtual, slot]

virtual void makVrf::DtAutoHidePanel::placeCompass

(

)

[protected, virtual, slot]

virtual void makVrf::DtAutoHidePanel::finalizeSetup

(

)

[protected, virtual, slot]

---

Member Data Documentation

makVrv::DtDe& makVrf::DtAutoHidePanel::myDe [protected]

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.

QTimer makVrf::DtAutoHidePanel::myTimer [protected]

Current item to be shown.

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.

---

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

• include/vrfGuiCoreQt/autoHidePanel.h