CTK  0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
Signals | Public Member Functions | Protected Member Functions | Properties | List of all members
ctkCheckablePushButton Class Reference

#include <Libs/Widgets/ctkCheckablePushButton.h>

Inheritance diagram for ctkCheckablePushButton:
Inheritance graph
[legend]
Collaboration diagram for ctkCheckablePushButton:
Collaboration graph
[legend]

Signals

void checkBoxToggled (bool)
 Fired anytime the checkbox change of state. More...
 
void checkStateChanged (Qt::CheckState newCheckState)
 Fired anytime the checkbox change of state. More...
 

Public Member Functions

virtual bool checkBoxControlsButton () const
 
virtual Qt::CheckState checkState () const
 
 ctkCheckablePushButton (const QString &text, QWidget *parent=0)
 
 ctkCheckablePushButton (QWidget *parent=0)
 
Qt::Alignment indicatorAlignment () const
 
virtual bool isCheckBoxUserCheckable () const
 
virtual void setCheckBoxControlsButton (bool b)
 
virtual void setCheckBoxUserCheckable (bool b)
 
virtual void setCheckState (Qt::CheckState checkState)
 
void setIndicatorAlignment (Qt::Alignment indicatorAlignment)
 
virtual ~ctkCheckablePushButton ()
 
- Public Member Functions inherited from ctkPushButton
Qt::Alignment buttonTextAlignment () const
 
 ctkPushButton (const QIcon &icon, const QString &text, QWidget *parent=0)
 
 ctkPushButton (const QString &text, QWidget *parent=0)
 
 ctkPushButton (QWidget *parent=0)
 
Qt::Alignment iconAlignment () const
 
virtual QSize minimumSizeHint () const
 
void setButtonTextAlignment (Qt::Alignment buttonTextAlignment)
 
void setIconAlignment (Qt::Alignment iconAlignment)
 
virtual QSize sizeHint () const
 
virtual ~ctkPushButton ()
 

Protected Member Functions

virtual bool hitButton (const QPoint &pos) const
 Reimplemented for internal reasons. More...
 
virtual void mousePressEvent (QMouseEvent *event)
 Reimplemented for internal reasons. More...
 
- Protected Member Functions inherited from ctkPushButton
 ctkPushButton (ctkPushButtonPrivate *, QWidget *parent=0)
 
virtual void paintEvent (QPaintEvent *)
 Reimplemented for internal reasons. More...
 

Properties

bool checkBoxControlsButton
 
bool checkBoxUserCheckable
 
Qt::CheckState checkState
 
Qt::Alignment indicatorAlignment
 
- Properties inherited from ctkPushButton
Qt::Alignment buttonTextAlignment
 
Qt::Alignment iconAlignment
 

Additional Inherited Members

- Protected Attributes inherited from ctkPushButton
QScopedPointer< ctkPushButtonPrivate > d_ptr
 

Detailed Description

Description ctkCheckablePushButton is a QPushButton with a checkbox. By default the checkbox is connected to the checkable property of the push button. You can change this behaviour by clearing the "checkBoxControlsButton" property. The checkBoxUserCheckable property determines if the state of the checkbox can be changed interactively by the user by clicking on the checkbox.

Note
In checkBoxControlsButton mode, calling setCheckable instead of setCheckState may not refresh the button automatically. Use setCheckState instead.
You can automatically check the button when the user checks the checkbox by connecting the checkBoxToggled(bool) signal with the setChecked(bool) slot.
Warning
The checkbox is drawn in place of the pushbuton icon, any icon will then be ignored.

Definition at line 48 of file ctkCheckablePushButton.h.

Constructor & Destructor Documentation

◆ ctkCheckablePushButton() [1/2]

ctkCheckablePushButton::ctkCheckablePushButton ( QWidget *  parent = 0)

◆ ctkCheckablePushButton() [2/2]

ctkCheckablePushButton::ctkCheckablePushButton ( const QString &  text,
QWidget *  parent = 0 
)

◆ ~ctkCheckablePushButton()

virtual ctkCheckablePushButton::~ctkCheckablePushButton ( )
virtual

Member Function Documentation

◆ checkBoxControlsButton()

virtual bool ctkCheckablePushButton::checkBoxControlsButton ( ) const
virtual

◆ checkBoxToggled

void ctkCheckablePushButton::checkBoxToggled ( bool  )
signal

Fired anytime the checkbox change of state.

◆ checkState()

virtual Qt::CheckState ctkCheckablePushButton::checkState ( ) const
virtual

◆ checkStateChanged

void ctkCheckablePushButton::checkStateChanged ( Qt::CheckState  newCheckState)
signal

Fired anytime the checkbox change of state.

◆ hitButton()

virtual bool ctkCheckablePushButton::hitButton ( const QPoint &  pos) const
protectedvirtual

Reimplemented for internal reasons.

◆ indicatorAlignment()

Qt::Alignment ctkCheckablePushButton::indicatorAlignment ( ) const

◆ isCheckBoxUserCheckable()

virtual bool ctkCheckablePushButton::isCheckBoxUserCheckable ( ) const
virtual

◆ mousePressEvent()

virtual void ctkCheckablePushButton::mousePressEvent ( QMouseEvent *  event)
protectedvirtual

Reimplemented for internal reasons.

◆ setCheckBoxControlsButton()

virtual void ctkCheckablePushButton::setCheckBoxControlsButton ( bool  b)
virtual

◆ setCheckBoxUserCheckable()

virtual void ctkCheckablePushButton::setCheckBoxUserCheckable ( bool  b)
virtual

◆ setCheckState()

virtual void ctkCheckablePushButton::setCheckState ( Qt::CheckState  checkState)
virtual

◆ setIndicatorAlignment()

void ctkCheckablePushButton::setIndicatorAlignment ( Qt::Alignment  indicatorAlignment)

Set the alignment of the indicator (arrow) on the button, Qt::AlignLeft|Qt::AlignVCenter by default.

Property Documentation

◆ checkBoxControlsButton

bool ctkCheckablePushButton::checkBoxControlsButton
readwrite

Definition at line 1 of file ctkCheckablePushButton.h.

◆ checkBoxUserCheckable

bool ctkCheckablePushButton::checkBoxUserCheckable
readwrite

Definition at line 1 of file ctkCheckablePushButton.h.

◆ checkState

Qt::CheckState ctkCheckablePushButton::checkState
readwrite

Definition at line 1 of file ctkCheckablePushButton.h.

◆ indicatorAlignment

Qt::Alignment ctkCheckablePushButton::indicatorAlignment
readwrite

This property controls the location of the checkbox with regard to the text. Qt::AlignLeft|Qt::AlignVCenter by default

Definition at line 1 of file ctkCheckablePushButton.h.


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