svg
└─── Layer1
      ├─── cdpText                    (text)
      ├─── cdpTextDisabled            (text)
      ├─── cdpBorderMarginTopLeft     (transparent rect/path)
      ├─── cdpBorderMarginBottomRight (transparent rect/path)
      ├─── cdpBackground              (element group)
      │     ├─── < Path >             (transparent rect/path)
      │     └─── < Group >            (background graphics)
      ├─── cdpBackgroundPressed       (element group)
      │     ├─── < Path >             (transparent rect/path)
      │     └─── < Group >            (background graphics)
      ├─── cdpButton                  (element group)
      │     ├─── < Path >             (transparent rect/path)
      │     └─── < Group >            (background graphics)
      ├─── cdpButtonPressed           (element group)
      │     ├─── < Path >             (transparent rect/path)
      │     └─── < Group >            (background graphics)
      ├─── cdpButtonChecked           (element group)
      │     ├─── < Path >             (transparent rect/path)
      │     └─── < Group >            (background graphics)
      ├─── cdpButtonDisabled           (element group)
      │     ├─── < Path >             (transparent rect/path)
      │     └─── < Group >            (background graphics)
      └─── cdpButtonDisabledChecked   (element group)
            ├─── < Path >             (transparent rect/path)
            └─── < Group >            (actual graphics)

svg
├─── Layer1
│     └─── ...                            (see previous section)
└─── Styles
      ├─── cdpTextStyleX                  (text)
      ├─── cdpTextDisabledStyleX          (text)
      ├─── cdpButtonStyleX                (element group)
      │     ├─── < Path >                 (transparent rect/path)
      │     └─── < Group >                (background graphics)
      ├─── cdpButtonPressedStyleX         (element group)
      │     ├─── < Path >                 (transparent rect/path)
      │     └─── < Group >                (background graphics)
      ├─── cdpButtonCheckedStyleX         (element group)
      │     ├─── < Path >                 (transparent rect/path)
      │     └─── < Group >                (background graphics)
      ├─── cdpButtonDisabledStyleX        (element group)
      │     ├─── < Path >                 (transparent rect/path)
      │     └─── < Group >                (background graphics)
      └─── cdpButtonDisabledCheckedStyleX (element group)
            ├─── < Path >                 (transparent rect/path)
            └─── < Group >                (actual graphics)

Property Documentation

cdpCheckedRouting : QString

This property holds the routing to a CDP object that is to control the checked state of the widget.

The routing is bi-directional, meaning that the button will both send and receive values by default. A button click will send value 1 on checked and 0 when unchecked. The same values will make the button toggle when changed remotely.

To send/receive a different value for the checked state, set checkableByEmitValue to true and use valueToEmit to set the value that should control the checked state. Receiving any value other than valueToEmit will make it unchecked. Clicking the button will no longer send 0 when entering the unchecked state. This is to enable use in button groups where different buttons sets the same routed object to different values.

The property named checkable must be set to true to allow the checked state.

Note that it is also possible to have separate routings for sending and receiving by setting checkableByClick to false. The button will still get checked by the object routed in cdpCheckedRouting, but you will now have to configure the button to send a message or change a remote value using other properties. See the usage guides for more details and be aware that you need to use a more advanced button than the standard CDPBaseButton. Instead, use CDPBaseButtonPopDlg or similar.

Take a look at the examples for complete usage guides.

Access functions:

See also valueToEmit, checkableByEmitValue, and checkableByClick.

cdpEnabledRouting : QString

This property holds the routing of the CDP object that is to enable/disable the button.

When the routed object is 0, the button will be disabled and will not react to user clicks. All values, starting at 1 and above will make the button enabled and ready for user interaction.

Access functions:

cdpPressedRouting : QString

This property holds the routing to a CDP object that should be set to 1 while the button is pressed.

The pressed routing makes the button behave like a hardware or I/O button as explained here. The control system needs to detect the user click in the component that owns the input signal or by using an edge triggered operator on the input.

Access functions:

cdpStyleRouting : QString

This property holds the routing of the CDP object that is to change the widget SVG style.

Most buttons do not have styles. The style must be provided to the button in the SVG file as described in the style section above. Different styles could show as a different color or button shape. Try adjusting widgetStyle to see what is in the SVG.

Access functions:

cdpVisibleRouting : const QString

This property holds the full path of the CDP object that is to control the visible state of the button.

See also visible.

checkableByClick : bool

This property holds whether to make it possible to check a button by click.

Note that the button can only get checked when the property named checkable is set true.

Access functions:

checkableByEmitValue : bool

This property holds or enables the button to get checked/unchecked when received value matches emit value.

When this property is set, the button will get checked only when the value received from cdpChecked is identical to valueToEmit, otherwise the button will get unchecked. Note that the button can only get checked when the property named checkable is set true. Also note that the autoExclusive property must be set to false if we want to enable that none of the buttons in a group have to be checked (often used in combination with checkableByClick set to false).

Access functions:

cssFile : QString

This property holds the css file to style the widget when styling type is set to css.

Access functions:

See also stylingType.

disabledStateOpacity : double

This property holds the level of opacity for the widget in the disabled state.

The valid range of opacity is from 1.0 (completely opaque) to 0.0 (completely transparent).

Setting this property configures a fixed opacity that can be different than the global opacity used in other widgets.

Access functions:

imageChecked : QString

This property holds the path of an image to show when checked.

Note: the image is overridden by the svg if enabled to do so in svgParsing (and with svg enabled in svgType).

Access functions:

imageNormal : QString

This property holds the path of an image to show when normal.

Note: the image is overridden by the svg if enabled to do so in svgParsing (and with svg enabled in svgType)

Access functions:

lockAspectRatio : bool

This property holds whether to keep the aspect ratio of the parsed image.

Note: scaledContent need to be set for this to have any effect.

Access functions:

lockWidgetStyle : bool

This property holds whether the widget style can be changed or not.

Access functions:

See also widgetStyle.

opaquePaintEvent : bool

This property holds whether the widget is transparent.

Set true to optimize painting when having no transparency in widget graphics This property should be set true on all widgets that does not require transparency. It will prevent Qt from painting widgets behind current widget and thus increase performance.

Access functions:

padInfoText1 : const QString

This property holds the first info text on the pad.

The property requires that the class set in CDPBaseMainWindow::numPadName implements the info text element. See the details of CDPBaseNumPad for more information.

See also padInfoText2.

padInfoText2 : const QString

This property holds the second info text on the pad.

The property requires that the class set in CDPBaseMainWindow::numPadName implements the info text element. See the details of CDPBaseNumPad for more information.

See also padInfoText1.

padTitle : const QString

This property holds the title name of the pad.

padType : GlobalDialog

This property holds pad type to get launched by the button.

When set to something other than none, the button will open a dialog of type NumPad, KeyPad or PinPad. The latter is normally used in the CDPBaseButtonPopDlg and not in the standard button as we also need to provide a pin code for this to be useful.

Access functions:

pushRoutables : const QStringList

Access functions:

Notifier signal:

scaledContents : bool

This property holds whether to scale the parsed image with the widget.

Access functions:

stylingType : StylingType

This property holds the styling type to style the widget.

Access functions:

See also svgFile.

svgBorderPixmap : bool

This property holds whether to Enable or disable border pixmap provided by the svg file.

The border pixmap makes the button maintain its corners and border sizes while being resized.

Access functions:

svgFile : QString

This property holds the path to the svg file that styles the widget.

The path can be either to a resource or a file on disk. Note that resources can be overridden by files on disk with identical names. In this widget, the svgFile property can only be edited when the svgType property is set to Custom.

Access functions:

svgFileChecked : QString

This property holds the path to the svg file that styles the widget in checked state.

Access functions:

svgParsing : SvgImageParsing

This property holds svg parsing decisions regarding where and when to use images.

The svgParsing property decides where/when to use the image parsed from svg. When svgType is set to NoSvg this property is ignored and the widget will use the images provided in imageNormal or imageChecked. When svg is enabled and svgParsing is set to ParseImages, the widget will use the svg images. Setting the property to ParseNormal will use the svg when button is normal and show the image provided in imageChecked when checked.

Access functions:

textColor : QColor

This property holds the text color in the normal button state.

Setting this property will override the default theme text color if the styling type is set to SVG. Other styling types will ignore the textColor property completely.

The property will not override colors in other button states, like disabled or checked, if such styling is provided by the SVG.

Access functions:

toggleOnPressed : bool

This property holds whether the button should get checked when pressing the button down or when it is released.

Making the button checked on release makes it possible for the user to change his/her mind after clicking the button by moving the mouse outside the button before releasing.

Access functions:

valueToEmit : int

This property holds the value that will get emitted in clicked(int) and checked(int) and is also used in various other properties like checkableByEmitValue.

Access functions:

visible : const bool

This property holds whether or not the widget is visible.

widgetPicture : int

This property holds switch between pictures in the selected style if provided in svg. If set a number of that don't exist in svg, picture 0 is shown.

Access functions:

widgetStyle : int

This property holds the widget style to use in the svg file (will only have effect if the svg file provides styles).

Access functions:

See also lockWidgetStyle.

connect(cDPBaseButton, static_cast<void(CDPBaseButton::*)(int)>(&CDPBaseButton::signalAcceptedValue),
    [=](int ){ /* ... */ });

connect(cDPBaseButton, static_cast<void(CDPBaseButton::*)(double)>(&CDPBaseButton::signalAcceptedValue),
    [=](double ){ /* ... */ });

connect(cDPBaseButton, static_cast<void(CDPBaseButton::*)(QString)>(&CDPBaseButton::signalAcceptedValue),
    [=](QString ){ /* ... */ });