svg
└─── Layer1
      ├─── cdpBorderMarginTopLeft     (transparent rect/path)
      ├─── cdpBorderMarginBottomRight (transparent rect/path)
      └─── cdpBackground              (element group)
            ├─── < Path >             (transparent rect/path)
            └─── < Group >            (background graphics)

svg
├─── Layer1
│     └─── ...                  (see previous section)
└─── Styles
      └─── cdpBackgroundStyleX  (element group)
            ├─── < Path >       (transparent rect/path)
            └─── < Group >      (background graphics)

Property Documentation

animEnable : bool

This property holds whether to enable size animation triggered by qt signals and slots.

Setting animEnabled to true, allows us to connect the slots named animateHeight() and animateWidth() and initiate/toggle the containers height and width. The distance is specified by animHeightPx and animWidthPx while animation duration is set in animHeightMs and animWidthMs.

Note: that the container must be in a layout for the animation to work.

Access functions:

See also animHeightPx, animWidthPx, animHeightMs, and animWidthMs.

animHeightMs : int

This property holds the duration of the height animation.

Access functions:

See also animHeightPx, animEnable, animWidthMs, and animWidthPx.

animHeightPx : int

This property holds the distance to move during height animation.

Access functions:

See also animWidthPx, animEnable, animHeightMs, and animWidthMs.

animStartIsMax : bool

This property holds whether or not the initial size is max or min.

Access functions:

See also animHeightPx, animEnable, animWidthMs, animWidthPx, and animHeightMs.

animWidthMs : int

This property holds the duration of the width animation.

Access functions:

See also animHeightPx, animEnable, animHeightMs, and animWidthPx.

animWidthPx : int

This property holds the distance to move during width animation.

Access functions:

See also animHeightPx, animEnable, animHeightMs, and animWidthMs.

borderMarginBottom : int

This property holds the bottom border margin.

Note that it will show the svg border margin if the svgBorderMargins property is set.

Access functions:

See also borderPixmap and svgBorderMargins.

borderMarginLeft : int

This property holds the left border margin.

Note that it will show the svg border margin if the svgBorderMargins property is set.

Access functions:

See also borderPixmap and svgBorderMargins.

borderMarginRight : int

This property holds the right border margin.

Note that it will show the svg border margin if the svgBorderMargins property is set.

Access functions:

See also borderPixmap and svgBorderMargins.

borderMarginTop : int

This property holds the top border margin.

Note that it will show the svg border margin if the svgBorderMargins property is set.

Access functions:

See also borderPixmap and svgBorderMargins.

borderPixmap : QString

This property holds the border pixmap to show in the container.

The path can be either to a resource or a file on a disk. Note that resources can be overridden by files on disk with identical names. The property can only be edited when the type property is set to "Custom".

Access functions:

See also svgBorderMargins.

cssFile : QString

This property holds the css file to style the widget.

Similar to the borderPixmap, the path is updated for the selected theme. Note that when both a css file and a borderPixmap is present, we have to select the CSS type to disable borderPixmap (for instance to style the container itself).

Access functions:

See also borderPixmap.

overlayUiFile : QString

This property holds the ui file to show as overlay on top of the container.

An overlay usually includes transparency and is used to cover different parts of the container. It can be used to show notification icons, text for offline state, or other graphics that can be turned on or off as a top layer.

The overlay is toggled on and off using the property named overlayVisible or by configuring routing in overlayVisibleRouting.

An example ui file could be a form based on CDPBaseContainer, configured with type set to CSS and cssFile set to themes/<theme name>/backgrounds/overlay.css.

Access functions:

See also overlayVisible and overlayVisibleRouting.

overlayVisible : bool

This property holds whether to show or hide the overlay provided in overlayUiFile.

Access functions:

See also overlayUiFile and overlayVisibleRouting.

overlayVisibleRouting : QString

This property holds routing for controlling overlayVisible property.

The user can also show and hide the overlay by toggling the overlayVisible property directly.

To have something to show and hide, the property named overlayUiFile must be configured.

Access functions:

See also overlayVisible and overlayUiFile.

svgBorderMargins : bool

This property holds whether to use the border margins provided in the svg file.

Note: the borderMargin properties will show the svg border margins when svgBorderMargins is set. Trying to change the borderMargins while svgBorderMargins is enabled will change the non svg border margins, but the changes wont show until the svgBorderMargins property is set to false.

Access functions:

See also borderPixmap, borderMarginBottom, borderMarginLeft, borderMarginTop, and borderMarginRight.

type : ContainerType

This property holds the styling type to use when styling the widget.

Setting it to "Custom", "Container" or "Title", changes the string in the borderPixmap property. The only difference is that the borderPixmap property can only be edited when type is set to "Custom". The type named "CSS" is different as it disables the borderPixmap and selects cssFile instead. When no cssFile is specified, the widget will function as an ordinary qt widget and show as transparent.

Access functions:

See also borderPixmap and cssFile.

visibleAboveWindowWidth : int

Access functions:

visibleBelowWindowWidth : int

Access functions: