makVrf::DtAutoHideDock Class Reference

Represents a new kind of dock widget: it has a "pin" button that allows the widget to pin/unpin from an autoHidePanel widget (if added to it) and a "close" button. It also adds an entry inside the "View" menu to show/hide the dock (if it is a palette type)

Inheritance diagram for makVrf::DtAutoHideDock:

Public Types
enum	DtAutoHideDockType { Palette = 0, Dialog }

Signals
void	signal_closing (DtAutoHideDock *dock)
void	signal_pinPressed (DtAutoHideDock *dock)
void	signal_topLevelChanged (DtAutoHideDock *dock)
void	signal_resized (DtAutoHideDock *dock)
void	signal_destroyed (DtAutoHideDock *dock)
void	signal_enter (DtAutoHideDock *dock)
void	signal_leave (DtAutoHideDock *dock)

Public Member Functions
	DtAutoHideDock (makVrv::DtDe &de, const QString &title="", const std::string &className="", QWidget *parent=0, Qt::WindowFlags flags=0)
	~DtAutoHideDock ()
virtual const makVrv::DtQIconConfigurations &	icon ()
virtual void	setIcon (const makVrv::DtQIconConfigurations &icon)
virtual DtAutoHideDockType	dockType () const
virtual void	setDockType (DtAutoHideDockType t)
virtual bool	pinned () const
virtual void	setPinned (bool flag)
virtual void	setupGui ()
virtual void	setShowWindowTitle (bool)
bool	showWindowTitle () const
virtual void	setTitle (const QString &title)
virtual void	setAdjustToMinimumSize (bool)
virtual bool	adjustToMinimumSize () const
const std::string &	className () const
virtual bool	keepAlive () const

Public Attributes
boost::signals2::signal< void()>	signal_windowTitleShownChanged

Protected Slots
virtual void	slot_closePressed ()
virtual void	slot_pinPressed (bool flag)
virtual void	slot_topLevelChanged (bool)

Protected Member Functions
virtual bool	eventFilter (QObject *p, QEvent *e)
virtual void	enterEvent (QEvent *event)
virtual void	leaveEvent (QEvent *event)
virtual void	closeEvent (QCloseEvent *event)
virtual void	paintEvent (QPaintEvent *p)
virtual void	resizeEvent (QResizeEvent *event)

Protected Attributes
makVrv::DtDe &	myDe
DtExtendedTitleBarWidget *	myTitleBarWidget
makVrv::DtQIconConfigurations	myIcon
DtAutoHideDockType	myDockType
bool	myAdjustToMinimumSize
std::string	myClassName
QColor	myTitleFillColorStop0
QColor	myTitleFillColorStop1
QColor	myOutlineInnerColor
QColor	myOutlineOuterColor
bool	myShowWindowTitle = true

Properties
QColor	TitleFillColorStop0
QColor	TitleFillColorStop1
QColor	OutlineInnerColor
QColor	OutlineOuterColor

Member Enumeration Documentation

enum makVrf::DtAutoHideDock::DtAutoHideDockType

Enumerator
Palette
Dialog

Constructor & Destructor Documentation

makVrf::DtAutoHideDock::DtAutoHideDock	(	makVrv::DtDe &	de,
		const QString &	title = "",
		const std::string &	className = "",
		QWidget *	parent = 0,
		Qt::WindowFlags	flags = 0
	)

Ctor.

makVrf::DtAutoHideDock::~DtAutoHideDock

(

)

Dtor.

Member Function Documentation

virtual const makVrv::DtQIconConfigurations& makVrf::DtAutoHideDock::icon ( )

virtual

Set/Get the icon.

virtual void makVrf::DtAutoHideDock::setIcon ( const makVrv::DtQIconConfigurations &  icon )

virtual

virtual DtAutoHideDockType makVrf::DtAutoHideDock::dockType ( ) const

virtual

Set/Get the type of dock this item represents.

virtual void makVrf::DtAutoHideDock::setDockType ( DtAutoHideDockType  t )

virtual

virtual bool makVrf::DtAutoHideDock::pinned ( ) const

virtual

Set/Get the pin status.

virtual void makVrf::DtAutoHideDock::setPinned ( bool  flag )

virtual

virtual void makVrf::DtAutoHideDock::setupGui ( )

virtual

Initializes the visuals of this object.

Reimplemented in makVrf::DtShapeObjectDefinitionDialog, makVrf::DtCircleObjectDefinitionDialog, makVrf::DtBoxObjectDefinitionDialog, makVrf::DtPointObjectDefinitionDialog, makVrf::DtComputedRouteDefinitionDialog, makVrf::DtComputeAerodromeDefinitionDialog, makVrf::DtNavigationAreaDefinitionDialog, makVrf::DtLocalWeatherAreaDefinitionDialog, makVrf::DtLocalWeatherBoxDefinitionDialog, makVrf::DtLocalWeatherCircleDefinitionDialog, vrfCustomControlObjectExample::DtCustomControlObjectDefinitionDialog, makVrf::DtScenarioEventDefinitionDialog, makVrf::DtWindCorridorDefinitionDialog, makVrf::DtIntelCollectionAreaDefinitionDialog, makVrf::DtMinefieldDefinitionDialog, makVrf::DtAirTurbulenceDefinitionDialog, makVrf::DtContaminationAreaDefinitionDialog, makVrf::DtMissileTargetDefinitionDialog, makVrf::DtMunitionDetonationDefinitionDialog, makVrf::DtIndirectArtilleryObjectDefinitionDialog, and makVrf::DtDynamicTerrainSwitchDialog.

virtual void makVrf::DtAutoHideDock::setShowWindowTitle ( bool  )

virtual

Sets whether or not to show the title on the button. Default is true.

bool makVrf::DtAutoHideDock::showWindowTitle ( ) const

inline

virtual void makVrf::DtAutoHideDock::setTitle ( const QString &  title )

virtual

Reimplemented in makVrf::DtShapeObjectDefinitionDialog, makVrf::DtCircleObjectDefinitionDialog, makVrf::DtBoxObjectDefinitionDialog, and makVrf::DtPointObjectDefinitionDialog.

virtual void makVrf::DtAutoHideDock::setAdjustToMinimumSize ( bool  )

virtual

Whether or not to adjust the size of the doc (on open) to minimum size. Default is true.

virtual bool makVrf::DtAutoHideDock::adjustToMinimumSize ( ) const

virtual

const std::string& makVrf::DtAutoHideDock::className ( ) const

inline

virtual bool makVrf::DtAutoHideDock::keepAlive ( ) const

virtual

Return true to keep this dock on display even after the mouse have left the dock widget. Use this carefully as the user will have to re-enter and leave (or close the dock widget) if this returns true. Default is false.

virtual bool makVrf::DtAutoHideDock::eventFilter ( QObject *  p, QEvent *  e  )

protectedvirtual

Event filter installed to listen for mouse events from the titleBarWidget.

virtual void makVrf::DtAutoHideDock::enterEvent ( QEvent *  event )

protectedvirtual

Automatic event that gets triggered when the mouse enters the widget.

virtual void makVrf::DtAutoHideDock::leaveEvent ( QEvent *  event )

protectedvirtual

Automatic event that gets triggered when the mouse leaves the widget.

virtual void makVrf::DtAutoHideDock::closeEvent ( QCloseEvent *  event )

protectedvirtual

This event gets automatically called when the widget is about to be closed.

Reimplemented in makVrf::DtShapeObjectDefinitionDialog, makVrf::DtCircleObjectDefinitionDialog, makVrf::DtBoxObjectDefinitionDialog, makVrf::DtPointObjectDefinitionDialog, makVrf::DtComputedRouteDefinitionDialog, and makVrf::DtComputeAerodromeDefinitionDialog.

virtual void makVrf::DtAutoHideDock::paintEvent ( QPaintEvent *  p )

protectedvirtual

This event gets automatically called when the widget is about to be painted on screen.

virtual void makVrf::DtAutoHideDock::resizeEvent ( QResizeEvent *  event )

protectedvirtual

void makVrf::DtAutoHideDock::signal_closing ( DtAutoHideDock *  dock )

signal

This signal gets emitted when the widget is closing. It passes itself as argument.

void makVrf::DtAutoHideDock::signal_pinPressed ( DtAutoHideDock *  dock )

signal

This signal gets emitted when the pin button is pressed on this widget. It passes itself as argument.

void makVrf::DtAutoHideDock::signal_topLevelChanged ( DtAutoHideDock *  dock )

signal

This signal gets emitted when this widget changes its status from docked to floating and vice versa. It passes itself as argument.

void makVrf::DtAutoHideDock::signal_resized ( DtAutoHideDock *  dock )

signal

This signal gets emitted when this widget is resized.

void makVrf::DtAutoHideDock::signal_destroyed ( DtAutoHideDock *  dock )

signal

This signal gets emitted when this widget is about to be destroyed.

void makVrf::DtAutoHideDock::signal_enter ( DtAutoHideDock *  dock )

signal

This signal gets emitted when the mouse enters on this widget.

void makVrf::DtAutoHideDock::signal_leave ( DtAutoHideDock *  dock )

signal

This signal gets emitted when the mouse leaves this widget.

virtual void makVrf::DtAutoHideDock::slot_closePressed ( )

protectedvirtualslot

Gets called when the close button is pressed on the titleBarWidget.

virtual void makVrf::DtAutoHideDock::slot_pinPressed ( bool  flag )

protectedvirtualslot

Gets called when the pin is pressed on the titleBarWidget.

virtual void makVrf::DtAutoHideDock::slot_topLevelChanged ( bool  )

protectedvirtualslot

Gets called when the widget changes its floating status.

Member Data Documentation

boost::signals2::signal<void ()> makVrf::DtAutoHideDock::signal_windowTitleShownChanged

makVrv::DtDe& makVrf::DtAutoHideDock::myDe

protected

DtExtendedTitleBarWidget* makVrf::DtAutoHideDock::myTitleBarWidget

protected

makVrv::DtQIconConfigurations makVrf::DtAutoHideDock::myIcon

protected

DtAutoHideDockType makVrf::DtAutoHideDock::myDockType

protected

bool makVrf::DtAutoHideDock::myAdjustToMinimumSize

protected

std::string makVrf::DtAutoHideDock::myClassName

protected

QColor makVrf::DtAutoHideDock::myTitleFillColorStop0

protected

QColor makVrf::DtAutoHideDock::myTitleFillColorStop1

protected

QColor makVrf::DtAutoHideDock::myOutlineInnerColor

protected

QColor makVrf::DtAutoHideDock::myOutlineOuterColor

protected

bool makVrf::DtAutoHideDock::myShowWindowTitle = true

protected

Property Documentation

QColor makVrf::DtAutoHideDock::TitleFillColorStop0

QColor makVrf::DtAutoHideDock::TitleFillColorStop1

QColor makVrf::DtAutoHideDock::OutlineInnerColor

QColor makVrf::DtAutoHideDock::OutlineOuterColor

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfGuiCommonQt/autoHideDock.h