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

Represents an element of the autoHidePanel. More...

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

Signals

void signal_enter (DtAutoHidePanelItem *)
 This signal gets emitted when the mouse enters the widget.
void signal_leave (DtAutoHidePanelItem *)
 This signal gets emitted when the mouse leaves the widget.
void signal_toggled (DtAutoHidePanelItem *)
 This signal gets emitted when the mouse is pressed over an instance of this class -only- applies when the type of item is Toggle.
void signal_clicked (DtAutoHidePanelItem *)
 This signal gets emitted when the mouse is pressed over an instance of this class -only- applies when the type of item is not Toggle.
void signal_availabilityChanged (DtAutoHidePanelItem *)
 This signal gets emitted when the item's availability changes.

Public Member Functions

 DtAutoHidePanelItem (makVrv::DtDe &de, QWidget *parent, QString title, const std::string &className)
 Constructor.
virtual ~DtAutoHidePanelItem ()
 Destructor.
DtAutoHideDockdockToManage ()
 Set/Get the dock widget associated with this item.
virtual void setDockToManage (DtAutoHideDock *widget)
virtual const QPixmap & icon () const
 Set/Get the display icon.
virtual void setIcon (const QIcon &p)
const std::string & className () const
 Class name.
virtual QString iconText ()
 Set/Get the text that gets displayed vertically next to the icon.
virtual void setIconText (const QString &s)
virtual bool toggled () const
 Set/Get the toggled status of the item.
virtual void setToggled (bool flag)
virtual void setSelected (bool flag)
 Sets the selected status of the item.
virtual void setAvailable (bool visible, bool updateVisibilityState=true)
 Sets the visibility of the item inside the panel.
virtual bool available () const
virtual void setAboutToBeShown (bool flag)
 Sets whether this item is about to be shown or not.
virtual void refreshSize (int minsize=-1)
 Calculates how large the area needs to be to display both the icon and the text.
virtual void setToggle (bool flag)
 Sets the type of item.

Protected Member Functions

virtual void enterEvent (QEvent *e)
 Event that happens when the mouse enters this widget.
virtual void leaveEvent (QEvent *)
 Event that happens when the mouse leaves this widget.
virtual void mouseReleaseEvent (QMouseEvent *event)
 Event that happens when the mouse is released on this widget.
virtual void paintEvent (QPaintEvent *p)
 Event that happens when the widget is about to be drawn on the screen.

Protected Attributes

QPixmap myIcon
QString myIconText
int myLeftMargin
int myRightMargin
int myTopMargin
int myBottomMargin
int mySpacing
bool myIsSelected
bool myIsToggled
DtAutoHideDockmyAutoHideDock
bool myAboutToBeShown
bool myIsToggleType
bool myIsAvailable
makVrv::DtDemyDe
std::string myClassName

Detailed Description

Represents an element of the autoHidePanel.

This element is represented as an icon + an icon text. The icon is displayed on top and the text is displayed below the icon vertically

Constructor & Destructor Documentation

makVrf::DtAutoHidePanelItem::DtAutoHidePanelItem ( makVrv::DtDe de,
QWidget *  parent,
QString  title,
const std::string &  className 
)

Constructor.

The title represents the text to be shown when the item is displayed.

virtual makVrf::DtAutoHidePanelItem::~DtAutoHidePanelItem ( )
virtual

Destructor.

Member Function Documentation

DtAutoHideDock* makVrf::DtAutoHidePanelItem::dockToManage ( )

Set/Get the dock widget associated with this item.

virtual void makVrf::DtAutoHidePanelItem::setDockToManage ( DtAutoHideDock widget)
virtual
virtual const QPixmap& makVrf::DtAutoHidePanelItem::icon ( ) const
virtual

Set/Get the display icon.

virtual void makVrf::DtAutoHidePanelItem::setIcon ( const QIcon &  p)
virtual
const std::string& makVrf::DtAutoHidePanelItem::className ( ) const
inline

Class name.

virtual QString makVrf::DtAutoHidePanelItem::iconText ( )
virtual

Set/Get the text that gets displayed vertically next to the icon.

virtual void makVrf::DtAutoHidePanelItem::setIconText ( const QString &  s)
virtual
virtual bool makVrf::DtAutoHidePanelItem::toggled ( ) const
virtual

Set/Get the toggled status of the item.

This only applies when the item type is set to Toggled (setToggle(true))

virtual void makVrf::DtAutoHidePanelItem::setToggled ( bool  flag)
virtual
virtual void makVrf::DtAutoHidePanelItem::setSelected ( bool  flag)
virtual

Sets the selected status of the item.

virtual void makVrf::DtAutoHidePanelItem::setAvailable ( bool  visible,
bool  updateVisibilityState = true 
)
virtual

Sets the visibility of the item inside the panel.

If updateVisibilityState is true, also update in layout manager

virtual bool makVrf::DtAutoHidePanelItem::available ( ) const
virtual
virtual void makVrf::DtAutoHidePanelItem::setAboutToBeShown ( bool  flag)
virtual

Sets whether this item is about to be shown or not.

virtual void makVrf::DtAutoHidePanelItem::refreshSize ( int  minsize = -1)
virtual

Calculates how large the area needs to be to display both the icon and the text.

virtual void makVrf::DtAutoHidePanelItem::setToggle ( bool  flag)
virtual

Sets the type of item.

virtual void makVrf::DtAutoHidePanelItem::enterEvent ( QEvent e)
protectedvirtual

Event that happens when the mouse enters this widget.

virtual void makVrf::DtAutoHidePanelItem::leaveEvent ( QEvent )
protectedvirtual

Event that happens when the mouse leaves this widget.

virtual void makVrf::DtAutoHidePanelItem::mouseReleaseEvent ( QMouseEvent *  event)
protectedvirtual

Event that happens when the mouse is released on this widget.

virtual void makVrf::DtAutoHidePanelItem::paintEvent ( QPaintEvent *  p)
protectedvirtual

Event that happens when the widget is about to be drawn on the screen.

void makVrf::DtAutoHidePanelItem::signal_enter ( DtAutoHidePanelItem )
signal

This signal gets emitted when the mouse enters the widget.

void makVrf::DtAutoHidePanelItem::signal_leave ( DtAutoHidePanelItem )
signal

This signal gets emitted when the mouse leaves the widget.

void makVrf::DtAutoHidePanelItem::signal_toggled ( DtAutoHidePanelItem )
signal

This signal gets emitted when the mouse is pressed over an instance of this class -only- applies when the type of item is Toggle.

void makVrf::DtAutoHidePanelItem::signal_clicked ( DtAutoHidePanelItem )
signal

This signal gets emitted when the mouse is pressed over an instance of this class -only- applies when the type of item is not Toggle.

void makVrf::DtAutoHidePanelItem::signal_availabilityChanged ( DtAutoHidePanelItem )
signal

This signal gets emitted when the item's availability changes.

Member Data Documentation

QPixmap makVrf::DtAutoHidePanelItem::myIcon
protected
QString makVrf::DtAutoHidePanelItem::myIconText
protected
int makVrf::DtAutoHidePanelItem::myLeftMargin
protected
int makVrf::DtAutoHidePanelItem::myRightMargin
protected
int makVrf::DtAutoHidePanelItem::myTopMargin
protected
int makVrf::DtAutoHidePanelItem::myBottomMargin
protected
int makVrf::DtAutoHidePanelItem::mySpacing
protected
bool makVrf::DtAutoHidePanelItem::myIsSelected
protected
bool makVrf::DtAutoHidePanelItem::myIsToggled
protected
DtAutoHideDock* makVrf::DtAutoHidePanelItem::myAutoHideDock
protected
bool makVrf::DtAutoHidePanelItem::myAboutToBeShown
protected
bool makVrf::DtAutoHidePanelItem::myIsToggleType
protected
bool makVrf::DtAutoHidePanelItem::myIsAvailable
protected
makVrv::DtDe& makVrf::DtAutoHidePanelItem::myDe
protected
std::string makVrf::DtAutoHidePanelItem::myClassName
protected

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

Document ID: Generated on Fri Apr 26 21:53:14 EDT 2019 from SVN revision 197883
Copyright © 2005-2019 VT MAK. All Rights Reserved (www.mak.com)