MeVisLab Scripting Reference
MLABButtonControl Class Reference

#include <mlabButtonControl.h>

Inherits MLABSimpleWidgetControl.

Public Types

enum  ButtonRole {
  AcceptRole = QDialogButtonBox::AcceptRole , RejectRole = QDialogButtonBox::RejectRole , DestructiveRole = QDialogButtonBox::DestructiveRole , ActionRole = QDialogButtonBox::ActionRole ,
  HelpRole = QDialogButtonBox::HelpRole , YesRole = QDialogButtonBox::YesRole , NoRole = QDialogButtonBox::NoRole , ApplyRole = QDialogButtonBox::ApplyRole ,
  ResetRole = QDialogButtonBox::ResetRole
}
 
- Public Types inherited from MLABWidgetControl
enum  TitleType
 

Scripting access.

void setTitle (const QString &title) override
 
QString title () const
 
void setPixmapFile (const QString &filename)
 
void setPixmap (const QPixmap &pixmap)
 
void setIcon (const QIcon &icon)
 
void setIconSize (const QSize &size)
 
QSize iconSize () const
 
void setRole (ButtonRole role)
 
void addDefaultTagValues (MLABTree *tree) const override
 

Additional Inherited Members

- 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 ()
 
- 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 ()
 
virtual void applyStyle ()
 
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

Button control.

This control shows a push button.

MDL reference: Button

Member Enumeration Documentation

◆ ButtonRole

Role of button in window/dialog.

Enumerator
AcceptRole 

Clicking the button causes the dialog to be accepted (e.g. OK).

RejectRole 

Clicking the button causes the dialog to be rejected (e.g. Cancel).

DestructiveRole 

Clicking the button causes a destructive change (e.g. for Discarding Changes) and closes the dialog.

ActionRole 

Clicking the button causes changes to the elements within the dialog.

HelpRole 

The button can be clicked to request help.

YesRole 

The button is a "Yes"-like button.

NoRole 

The button is a "No"-like button.

ApplyRole 

The button applies current changes.

ResetRole 

The button resets the dialog's fields to default values.

Member Function Documentation

◆ iconSize

QSize MLABButtonControl::iconSize ( ) const
slot

Gets the current icon size of the button.

◆ setIcon

void MLABButtonControl::setIcon ( const QIcon &  icon)
slot

Sets a new icon.

◆ setIconSize

void MLABButtonControl::setIconSize ( const QSize &  size)
slot

Sets a different icon size for the used icon.

◆ setPixmap

void MLABButtonControl::setPixmap ( const QPixmap &  pixmap)
slot

Sets the icon of the button from given pixmap.

This method sets the icon size of the button to the size of the pixmap. If you want to use a different icon size, you can call setIconSize() after setting the pixmap.

◆ setPixmapFile

void MLABButtonControl::setPixmapFile ( const QString &  filename)
slot

Sets the icon of the button from given file (absolute filename required).

This method sets the icon size of the button to the size of the pixmap. If you want to use a different icon size, you can call setIconSize() after setting the pixmap.

◆ setRole

void MLABButtonControl::setRole ( ButtonRole  role)
slot

Sets role of the button.

◆ setTitle

void MLABButtonControl::setTitle ( const QString &  title)
overrideslot

Sets the title of the button.

◆ title

QString MLABButtonControl::title ( ) const
slot

Gets the title of the button.