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

Inheritance diagram for makVrf::DtAutoHidePanel:

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)
	Registers the dock to be managed by the panel.
virtual void	clear ()
	Removes all the items from the panel.
virtual DtAutoHidePanelItem *	findItemForClass (const std::string &s)
virtual DtAutoHidePanelItem *	findItemForDock (const DtAutoHideDock *dock)
virtual void	setPanelItemVisible (const std::string &panelClassName, bool, bool updateVisibilityState=false)
	Sets the particular panel item to be visible or not. If updateVisibilityState is true, also update in layout manager.
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 std::vector< std::pair < DtString, QString > >	panelsThatCanBeUsedOnCreateMenu () const
	Returns a list of panels (keyword/title) that can be used on a create menu.
virtual void	changeVisibility (bool)
	Implement the visibility change of the widget.
virtual bool	findDock (DtAutoHideDock *dock)
virtual void	changeLocation (makVrv::DtPageConfiguration::PageCollectionLocation)
	No-op. Cannot change location or geometry.
virtual void	changeFloatingGeometry (int px, int py, int width, int height)
	Implement changing the floating geometry of the collection.
virtual void	changeFloatingGeometry (makVrv::DtPageConfiguration::PageCollectionGeometry geometry)
	Implement changing the floating geometry of the collection.
virtual void	changeDockedGeometry (int px, int py, int width, int height)
	Implement changing the docked geometry of the collection.
virtual void	changeDockedGeometry (makVrv::DtPageConfiguration::PageCollectionGeometry geometry)
	Implement changing the docked geometry of the collection.
virtual void	selectPage (const std::string &pageClassName)
	Implement selecting a page by name.
const DtAutoHideDockList &	docks () const
template<typename PaletteClass >
PaletteClass *	createPalette ()
template<typename PaletteClass >
DtAutoHideDock *	creationDock ()
virtual DtEntityCreatePalette *	entityCreatePalette ()
	Return the entity create palette.
virtual DtAutoHideDock *	entityCreationDock ()
virtual DtHazardAreaCreatePalette *	hazardAreaCreatePalette ()
	Return the hazard area create palette.
virtual DtAutoHideDock *	hazardAreaCreationDock ()
virtual DtTacticalGraphicCreatePalette *	tacticalGraphicCreatePalette ()
	Return the tactical graphic create palette.
virtual DtAutoHideDock *	tacticalGraphicCreationDock ()
virtual DtPropCreatePalette *	propCreatePalette ()
	Return the prop create palette.
virtual DtAutoHideDock *	propCreationDock ()
virtual void	setItemPinned (DtAutoHidePanelItem *, bool)
	Sets whether or not the item is pinned.
Public Member Functions inherited from makVrv::DtQtPageCollection
	DtQtPageCollection (DtDe &de, const std::string &collectionClassName)
	CTOR.
virtual	~DtQtPageCollection ()
	DTOR, this will delete all currently added pages.
void	addPage (DtPage *page)
	Add a page to the collection, the collection will assume ownership of the pointer.
void	removePage (DtPage *page, bool deletePage=true)
	Remove a page that was previously added.
DtPage *	findPage (const std::string &pageClassName)
	Find a page. Returns 0 if the page wasn't added.
const DtPage *	findPage (const std::string &pageClassName) const
	Find a page. Returns 0 if the page wasn't added.
const PageMap &	pages () const
	Get the currently available pages.
virtual void	removeContainer ()
	Removes the collection from the GUI (does not delete it)
virtual void	bringToTop ()
	Brings the panel to the front (when it is tabbed)
Public Member Functions inherited from makVrv::DtPageCollection
	DtPageCollection (DtDe &de, const std::string &collectionClassName)
	CTOR, this automatically registers the interface with the makVrv::DtPageCollectionManager instance.
virtual	~DtPageCollection ()
	DTOR, this automatically unregisters the interface with the makVrv::DtPageCollectionManager instance.
const std::string &	collectionClassName () const
	Get the collection class name.
const PageClassList &	pageClasses () const
	Get a list of all the page classes contained in this collection.
void	show (const std::string &page=std::string(""))
	Show the collection of pages.
void	hide ()
	Hide the collection of pages.
bool	visible () const
	Get whether the collection is currently visible.
virtual int	tabIndex () const
	If this page collection has been tabified, returns the index inside the tab collection where this collection is.
virtual bool	isTabbed () const
	Returns true if this collection has been tabified.
DtPageConfiguration::PageCollectionLocation	location () const
	Get the current location of the collection.
void	setLocation (DtPageConfiguration::PageCollectionLocation location)
	Set the current location of the collection.
DtPageConfiguration::PageCollectionGeometry &	floatingGeometry ()
	Get the current geometry of the collection.
void	setFloatingGeometry (DtPageConfiguration::PageCollectionGeometry geometry)
	//! Set the current floating geometry for the collection
void	setFloatingGeometry (int px, int py, int width, int height)
	Set the current floating geometry for the collection.
virtual DtPageConfiguration::PageCollectionGeometry	dockedGeometry ()
	Get the current docked geometry of the collection.
void	setDockedGeometry (DtPageConfiguration::PageCollectionGeometry geometry)
	Set the current docked geometry for the collection.
void	setDockedGeometry (int px, int py, int width, int height)
	Set the current docked geometry for the collection.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

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 void	removeDock (DtAutoHideDock *dock)
virtual void	relocateAnyPinnedDock ()
virtual void	refreshItems (int minsize)
virtual void	refreshAppearanceOfItem (DtAutoHidePanelItem *autoHideItemWidget, bool forceVisible)
virtual void	addPageToGui (makVrv::DtPage *)
	Implement adding the page to the GUI.
virtual void	removePageFromGui (makVrv::DtPage *)
	Implement removing a page from the GUI.
virtual void	selectPageInGui (makVrv::DtPage *page)
	Implement selecting a page in the GUI.
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)
	Subclasses must call this when a page is added.
void	removePageClass (const std::string &pageClassName)
	Subclasses must call this when a page is removed.

Protected Attributes
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.
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::signal< void()>	signal_shown
boost::signal< void()>	signal_hidden
boost::signal< void(const std::string &)>	signal_pageSelected

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 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 ( 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 ( 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 DtHazardAreaCreatePalette* makVrf::DtAutoHidePanel::hazardAreaCreatePalette ( )

inlinevirtual

Return the hazard area create palette.

virtual DtAutoHideDock* makVrf::DtAutoHidePanel::hazardAreaCreationDock ( )

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 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 int makVrf::DtAutoHidePanel::maxItemWidth ( )

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.

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:

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfGuiCoreQt/autoHidePanel.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation