MeVisLab Scripting Reference
MLABCommonButtonGroupControl Class Referenceabstract

#include <mlabButtonGroupControls.h>

Inherits MLABWidgetControl.

Inherited by MLABButtonBarControl, MLABPushOrToolButtonGroupControl, and MLABRadioButtonGroupControl.

Public Slots

Button access.

These methods add remove buttons and allows to access the Qt objects.

QAbstractButton * addButton (const QString &name, const QString &title, const QPixmap &icon)
 
QAbstractButton * addButton (const QString &name, const QString &title, const QIcon &icon)
 
void removeButton (const QString &name)
 
void removeAllButtons ()
 
QStringList getButtonNames () const
 
QAbstractButton * getButton (const QString &name, bool verbose=false)
 
Button Group Properties

These methods set properties of the button group and affect all buttons.

void setCheckableButtons (bool checkable)
 
void setExclusiveButtons (bool exclusiveButtons)
 
- Public Slots inherited from MLABWidgetControl
void adjustSize ()
 
virtual void setEnabled (bool flag)
 
virtual void setVisible (bool flag)
 
virtual bool isVisible ()
 
virtual void setFocus ()
 
virtual bool hasFocus ()
 
virtual void setToolTip (const QString &string)
 
virtual void setWhatsThis (const QString &string)
 
void displayWhatsThis ()
 
void displayWhatsThis (const QString &text)
 
virtual void setTitle (const QString &)
 
QWidget * widget ()
 
QLayout * layout ()
 
virtual QString windowHandle ()
 
virtual bool createScreenshot (const QString &filename, bool grabFromScreen=true, bool scaleToLowRes=false)
 
bool isReloadable () const
 
void reload (MLABTree *tree)
 
QString createGlobalScreenshot ()
 
QString applicationName ()
 
QSize size ()
 
int width ()
 
int height ()
 
int minWidth ()
 
int minHeight ()
 
int maxWidth ()
 
int maxHeight ()
 
virtual void setMinWidth (int s)
 
virtual void setMinHeight (int s)
 
void setMaxWidth (int s)
 
void setMaxHeight (int s)
 
QSize sizeHint ()
 
QSize minSize ()
 
QSize maxSize ()
 
void setMinSize (QSize size)
 
void setMaxSize (QSize size)
 
void updateLayout ()
 
int windowID ()
 
MLABWidgetControlcontrol (const QString &name)
 
float scaleFactor ()
 
MLABModulemodule ()
 
QString getType ()
 
QString getName ()
 
bool acceptDrops ()
 
void setAcceptDrops (bool flag)
 
void raiseWidget ()
 
void setStyleSheetFromString (const QString &styleSheetText)
 
void setStyleSheetFromFile (const QString &styleSheetFileName)
 
MLABTreetree ()
 
void updateMaxSize ()
 
bool expandX ()
 
bool expandY ()
 
MLABTreePtr getDefaultTagValues () const
 
virtual bool hasUncommittedChanges () const
 
virtual void applyUncommittedChanges ()
 
virtual void revertUncommittedChanges ()
 
MLABFieldfield () const
 
virtual QString py_toString ()
 

Properties

bool checkableButtons
 
bool exclusiveButtons
 

Button Properties

These methods provide set/get access to individual button properties.

They print an error if the specified button does not exist.

bool _useButtonCountAsStripCountDefault
 
bool _checkableButtonsDefault
 
QList< MLABCommonButtonGroupItem * > _items
 
QPointer< MLABIntegerField_integerField
 
QPointer< MLABEnumField_enumField
 
unsigned int _stripCount
 
Qt::Orientation _orientation
 
bool _checkableButtons
 
bool _showIconsOnly
 
QButtonGroup * _buttonGroup
 
bool _equalButtonWidths
 
bool _equalButtonHeights
 
bool _isEqualButtonSizeDirty
 
bool _isButtonBar
 
static const bool _borderDefault = false
 
static const QString _orientationDefault
 
static const int _defaultSpacing = 4
 
static const int _defaultStrips = 1
 
static const int _defaultMargin = 2
 
static const bool _showButtonNamesDefault = false
 
static const bool _showIconsOnlyDefault = false
 
static const bool _stripEnumItemPrefixDefault = false
 
void setButtonChecked (const QString &name, bool checked)
 
bool isButtonChecked (const QString &name)
 
void setButtonEnabled (const QString &name, bool enabled)
 
bool isButtonEnabled (const QString &name)
 
void setButtonVisible (const QString &name, bool visible)
 
bool isButtonVisible (const QString &name)
 
void setButtonTitle (const QString &name, const QString &title)
 
QString getButtonTitle (const QString &name)
 
void setButtonToolTip (const QString &name, const QString &toolTip)
 
QString getButtonToolTip (const QString &name)
 
void setButtonWhatsThis (const QString &name, const QString &whatsThis)
 
QString getButtonWhatsThis (const QString &name)
 
void setButtonIcon (const QString &name, const QIcon &icon)
 
QIcon getButtonIcon (const QString &name)
 
void fieldChanged ()
 
void buttonReleased (QAbstractButton *button)
 
void buttonPressed (QAbstractButton *button)
 
void buttonClicked (QAbstractButton *button)
 
void equalizeButtonSizesDelayed ()
 
void buttonPressed (const QString &buttonName)
 
void buttonReleased (const QString &buttonName)
 
void buttonClicked (const QString &buttonName)
 
virtual QWidget * createWidget (QWidget *parent)
 
virtual QAbstractButton * createButton (MLABCommonButtonGroupItem *item, MLABTree *buttonTree, const QPixmap &pixmap=QPixmap())=0
 
virtual void handleFieldChanged (MLABCommonButtonGroupItem *item)
 
void applyStyle () override
 
void addDefaultTagValues (MLABTree *tree) const override
 
void updateSizeHintsAndResize ()
 
QList< QAbstractButton * > getButtons ()
 
virtual void addButtonsToGridLayout ()
 
void equalizeButtonSizes ()
 
static QPushButton * createPushButton (MLABCommonButtonGroupItem *item, QPixmap &pixmap, bool flatButtons, bool showIconsOnly)
 
static QRadioButton * createRadioButton (MLABCommonButtonGroupItem *item, QPixmap &pixmap, bool showIconsOnly)
 
static QToolButton * createToolButton (MLABCommonButtonGroupItem *item, QPixmap &pixmap, const QSize &defaultIconSize, bool autoScale, bool autoRaise, bool showIconsOnly)
 

Additional Inherited Members

- Public Types inherited from MLABWidgetControl
enum  TitleType
 
- Public Member Functions inherited from MLABWidgetControl
bool createScreenshot (QWidget *widget, const QString &filename, int x=0, int y=0, int w=-1, int h=-1, bool grabFromScreen=true, bool scaleToLowRes=false)
 
void setStyle (MLABStyle *proto)
 
MLABStyle * style ()
 
QString buildTitleString (MLABField *optionalField, bool splitUppercase, TitleType *resultTitleType=nullptr)
 
void evaluateVisibleOnExpression ()
 
- Static Public Member Functions inherited from MLABWidgetControl
static bool showMDLFileForWidget (QWidget *w)
 
static bool showHelpContextMenuForWidget (QWidget *w)
 
static QKeySequence getKeySequence (const MLABTree *attrib)
 
static QString trimString (const QString &s, QWidget *w, trim mode)
 
- Protected Slots inherited from MLABWidgetControl
void emitResizeCommand ()
 
void updateEnabledState ()
 
void setVisibleDelayed (bool visible)
 
void tooltipFieldChanged ()
 
- Protected Member Functions inherited from MLABWidgetControl
void setupEditedField ()
 
virtual void internalReload ()
 
void addDefaultTagValue (MLABTree *tree, const QString &tagName, const QString &tagValue) const
 
void addDefaultTagValue (MLABTree *tree, const QString &tagName, const char *tagValue) const
 
void addDefaultTagValue (MLABTree *tree, const QString &tagName, bool tagValue) const
 
void addDefaultTagValue (MLABTree *tree, const QString &tagName, int tagValue) const
 
void addDefaultTagValue (MLABTree *tree, const QString &tagName, unsigned int tagValue) const
 
void addDefaultTagValue (MLABTree *tree, const QString &tagName, float tagValue) const
 
void addDefaultTagValue (MLABTree *tree, const QString &tagName, double tagValue) const
 
bool verifyThatParentsHaveDifferentAlignGroups (const QString &alignGroup, bool isXAlign)
 
MLABFieldlookupField (const QString fieldname, MLABTree *tree, const char *classname=nullptr, bool warn=true)
 
QPixmap readPixmap (MLABTree *tree)
 
QPixmap readPixmap (const QString &filename)
 
QPixmap readPixmap (MLABTree *tree, float scale)
 
QPixmap readPixmap (const QString &filename, float scale)
 
QImage readImage (MLABTree *tree, float scale)
 
QImage readImage (const QString &filename, float scale)
 
void updateMaxSize (bool maygrow)
 
QString trimString (const QString &s, QWidget *w)
 
void setupScaleFactor ()
 
QString uniqueGroupString ()
 
bool createIconSet (QIcon &icon, QAbstractButton *button=nullptr, bool autoScale=false)
 
bool createIconSetPixmap (QIcon &iconset, const QString &name, QIcon::Mode mode, QIcon::State state, bool resize=false, QSize *scaleSize=nullptr)
 
bool createIconSet (MLABTree *tree, QIcon &icon, QAbstractButton *button=nullptr, bool autoScale=false)
 
bool createIconSetPixmap (MLABTree *tree, QIcon &iconset, const QString &name, QIcon::Mode mode, QIcon::State state, bool resize=false, QSize *scaleSize=nullptr)
 
QSize defaultIconSize ()
 
QString loadStyleSheetFile (const QString &styleSheetFileName)
 
- Static Protected Member Functions inherited from MLABWidgetControl
static QString loadTextFileWithReplacedMDLVariables (const QString &filename)
 
static bool shouldExpandCheck (MLABTree *t)
 
static QString removeStyleSheetComments (const QString &style)
 
- Protected Attributes inherited from MLABWidgetControl
struct MLABWidgetControl::__flags _flags
 
MLABTreePtr _tree
 
MLABTreePtr _prototype
 
MLABStylePtr _style
 
QWidget * _widget
 
int _windowId
 
float _scale
 
MLABWidgetControlContextInfo * _info
 
int _controlType
 
QString _alignGroupX
 
QString _alignGroupY
 
QString _alignGroupLabels
 
QString _alignChildX
 
QString _alignChildY
 
int _maxColIndex
 
int _maxRowIndex
 
int _layoutXDepth
 
int _layoutYDepth
 
QPointer< MLABModule_module
 
QPointer< MLABField_field
 
QPointer< MLABField_tooltipField
 
MLABFieldExpressionEvaluator * _visibleOnEvaluator
 
trim _trim
 
bool _isReloadable
 
- Static Protected Attributes inherited from MLABWidgetControl
static MLABTreePtr _currentAttrib
 
static int _uniqAlignGroupCounter
 
static const bool expandXDefault = false
 
static const bool expandYDefault = false
 
static const QString alignXDefault
 
static const QString alignYDefault
 
static const QString bgModeDefault
 
static const QString editBgModeDefault
 
static const QString buttonBgModeDefault
 
static const int colspanDefault = 1
 

Detailed Description

CommonButtonGroup control.

The base control for handling a group of buttons.

MDL reference: CommonButtonGroup

Member Function Documentation

◆ addButton [1/2]

QAbstractButton * MLABCommonButtonGroupControl::addButton ( const QString &  name,
const QString &  title,
const QIcon &  icon 
)
slot

Adds a button with the given name title and icon to the group.

This function may only be called if the button group is not associated to a enum field, because the enumerations specify the available buttons.

◆ addButton [2/2]

QAbstractButton * MLABCommonButtonGroupControl::addButton ( const QString &  name,
const QString &  title,
const QPixmap &  icon 
)
slot

Adds a button with the given name title and icon to the group.

This is an overloaded function that uses a simple pixmap as icon.

◆ getButton

QAbstractButton * MLABCommonButtonGroupControl::getButton ( const QString &  name,
bool  verbose = false 
)
slot

Returns the button with the given name, or NULL if no such button exists.

If verbose is true, then an error messages is printed if the button does not exist.

◆ getButtonIcon

QIcon MLABCommonButtonGroupControl::getButtonIcon ( const QString &  name)
slot

Returns the icon.

◆ getButtonNames

QStringList MLABCommonButtonGroupControl::getButtonNames ( ) const
slot

Returns the names of all buttons.

◆ getButtonTitle

QString MLABCommonButtonGroupControl::getButtonTitle ( const QString &  name)
slot

Returns the title.

◆ getButtonToolTip

QString MLABCommonButtonGroupControl::getButtonToolTip ( const QString &  name)
slot

Returns the tooltip text.

◆ getButtonWhatsThis

QString MLABCommonButtonGroupControl::getButtonWhatsThis ( const QString &  name)
slot

Returns the What's This help text.

◆ isButtonChecked

bool MLABCommonButtonGroupControl::isButtonChecked ( const QString &  name)
slot

Returns whether the button is checked.

◆ isButtonEnabled

bool MLABCommonButtonGroupControl::isButtonEnabled ( const QString &  name)
slot

Returns whether the button is enabled.

◆ isButtonVisible

bool MLABCommonButtonGroupControl::isButtonVisible ( const QString &  name)
slot

Returns whether the button is visible.

◆ removeAllButtons

void MLABCommonButtonGroupControl::removeAllButtons ( )
slot

Removes all buttons from the group.

This function may only be called if the button group is not associated to a enum field, because the enumerations specify the available buttons.

◆ removeButton

void MLABCommonButtonGroupControl::removeButton ( const QString &  name)
slot

Removes a button from the group.

This function may only be called if the button group is not associated to a enum field, because the enumerations specify the available buttons.

◆ setButtonChecked

void MLABCommonButtonGroupControl::setButtonChecked ( const QString &  name,
bool  checked 
)
slot

Sets whether the button is checked.

◆ setButtonEnabled

void MLABCommonButtonGroupControl::setButtonEnabled ( const QString &  name,
bool  enabled 
)
slot

Sets whether the button is enabled.

◆ setButtonIcon

void MLABCommonButtonGroupControl::setButtonIcon ( const QString &  name,
const QIcon &  icon 
)
slot

Sets the icon.

◆ setButtonTitle

void MLABCommonButtonGroupControl::setButtonTitle ( const QString &  name,
const QString &  title 
)
slot

Sets the title.

◆ setButtonToolTip

void MLABCommonButtonGroupControl::setButtonToolTip ( const QString &  name,
const QString &  toolTip 
)
slot

Sets the tooltip text.

◆ setButtonVisible

void MLABCommonButtonGroupControl::setButtonVisible ( const QString &  name,
bool  visible 
)
slot

Sets whether the button is visible.

◆ setButtonWhatsThis

void MLABCommonButtonGroupControl::setButtonWhatsThis ( const QString &  name,
const QString &  whatsThis 
)
slot

Sets the What's This help text.

◆ setCheckableButtons

void MLABCommonButtonGroupControl::setCheckableButtons ( bool  checkable)
slot

Sets whether buttons are checkable. This has no effect on radio buttons.

◆ setExclusiveButtons

void MLABCommonButtonGroupControl::setExclusiveButtons ( bool  exclusiveButtons)
slot

Sets whether buttons are exclusively checked.

Property Documentation

◆ checkableButtons

bool MLABCommonButtonGroupControl::checkableButtons
readwrite

Buttons are checkable (cannot be false if control is associated with a field).

◆ exclusiveButtons

bool MLABCommonButtonGroupControl::exclusiveButtons
readwrite

Buttons are exclusive (only sensible if buttons are checkable, cannot be false if control is associated with a field).