Widget

Search…
Widget
To access the property from outside:
1
document.childByName("Widget name").PROPERTY_NAME
Copied!
To access the property from the current item:
1
widget.PROPERTY_NAME
Copied!
Property
Function
Type
Title
Item title

Actions editor:
Property > Title
Code:
widget.title
string
Visible
Sets item visibility

Actions editor:
Property > Visible
Code:
widget.visible
bool
Maximized
Gets true if widget is maximized

Actions editor:
Property > Maximized
Code:
widget.increased
bool
Geometry
Property
Function
Type
X
Sets x position relative to the page

Actions editor:
Property > Geometry > X
Code:
widget.x
double
Y
Sets y position relative to the page

Actions editor:
Property > Geometry > Y
Code:
widget.y
double
Width
Sets width relative to the page

Actions editor:
Property > Geometry > Width
Code:
widget.width
double
Height
Sets height relative to the page

Actions editor:
Property > Geometry > Height
Code:
widget.height
double
Fixed width
Enable to fix width

Actions editor:
Property > Geometry > Fixed width
Code:
widget.fixedWidth
bool
Fixed height
Enable to fix height

Actions editor:
Property > Geometry > Fixed height
Code:
widget.fixedHeight
bool
Align left
Enable to left align

Actions editor:
Property > Geometry > Align left
Code:
widget.anchorLeft
bool
Align right
Enable to right align

Actions editor:
Property > Geometry > Align right
Code:
widget.anchorRight
bool
Align top
Enable to top align

Actions editor:
Property > Geometry > Align top
Code:
widget.anchorTop
bool
Align bottom
Enable to bottom align

Actions editor:
Property > Geometry > Align bottom
Code:
widget.anchorBottom
bool
Margin left
Sets left margin relative to the page

Actions editor:
Property > Geometry > Margin left
Code:
widget.marginLeft
double
Margin right
Sets right margin relative to the page

Actions editor:
Property > Geometry > Margin right
Code:
widget.marginRight
double
Margin top
Sets top margin relative to the page

Actions editor:
Property > Geometry > Margin top
Code:
widget.marginTop
double
Margin bottom
Sets bottom margin relative to the page

Actions editor:
Property > Geometry > Margin bottom
Code:
widget.marginBottom
double
Vertically center
Enable to vertically center item

Actions editor:
Property > Geometry > Vertically center
Code:
widget.anchorVerticalCenter
bool
Horizontally center
Enable to horizontally center item

Actions editor:
Property > Geometry > Horizontally center
Code:
widget.anchorHorizontalCenter
bool
Scale
Sets scale factor

Actions editor:
Property > Geometry > Scale
Code:
widget.scale
double
ZOrder
Sets stacking order. By default is 0.

Actions editor:
Property > Geometry > ZOrder
Code:
widget.zOrder
int
TextureX
Sets texture x offset

Actions editor:
Property > Geometry > TextureX
Code:
widget.textureX
double
Rotation
Property
Function
Type
X rotation
Sets rotation in degrees about the x

Actions editor:
Property > Geometry > Rotation > X rotation
Code:
widget.rotationX
double
Y rotation
Sets rotation in degrees about the y

Actions editor:
Property > Geometry > Rotation > Y rotation
Code:
widget.rotationY
double
Z rotation
Sets rotation in degrees about the z

Actions editor:
Property > Geometry > Rotation > Z rotation
Code:
widget.rotationZ
double
X offset
Sets origin point offset for x

Actions editor:
Property > Geometry > Rotation > X offset
Code:
widget.rotationXOriginX
double
Y offset
Sets origin point offset for y

Actions editor:
Property > Geometry > Rotation > Y offset
Code:
widget.rotationYOriginX
double
Origin point
Sets origin point of the rotation

Actions editor:
Property > Geometry > Rotation > Origin point
Code:
widget.rotationSnap
flags
Style
Property
Function
Type
Opacity
Sets widget opacity

Actions editor:
Property > Style > Opacity
Code:
widget.style.pageItemOpacity
double
Border
Property
Function
Type
Border color
Sets widget border color

Actions editor:
Property > Style > Border > Border color
Code:
widget.style.pageItemBorderColor
color
Border width
Sets widget border width

Actions editor:
Property > Style > Border > Border width
Code:
widget.style.pageItemBorderWidth
int
Border radius
Sets widget border radius

Actions editor:
Property > Style > Border > Border radius
Code:
widget.style.pageItemBorderRadius
double
Left border width
Sets widget left border width

Actions editor:
Property > Style > Border > Left border width
Code:
widget.style.pageItemBorderLeft
int
Top border width
Sets widget top border width

Actions editor:
Property > Style > Border > Top border width
Code:
widget.style.pageItemBorderTop
int
Right border width
Sets widget right border width

Actions editor:
Property > Style > Border > Right border width
Code:
widget.style.pageItemBorderRight
int
Bottom border width
Sets widget bottom border width

Actions editor:
Property > Style > Border > Bottom border width
Code:
widget.style.pageItemBorderBottom
int
Background
Property
Function
Type
Background color
Sets widget background color

Actions editor:
Property > Style > Background > Background color
Code:
widget.style.pageItemBackgroundColor
color
Background image
Sets widget background image

Actions editor:
Property > Style > Background > Background image
Code:
widget.style.pageItemBackgroundMedia
string
Background image fill mode
Sets widget background fill mode

Actions editor:
Property > Style > Background > Background image fill mode
Code:
widget.style.pageItemBackgroundFillMode
enum

Values:
Stretch
PreserveAspectFit
PreserveAspectCrop
Tile
TileVertically
TileHorizontally
Pad
Mask
Property
Function
Type
Mask image
Sets widget mask image

Actions editor:
Property > Style > Mask > Mask image
Code:
widget.style.pageItemMaskMedia
string
Mask fill mode
Sets widget mask fill mode

Actions editor:
Property > Style > Mask > Mask fill mode
Code:
widget.style.pageItemMaskFillMode
enum

Values:
Stretch
PreserveAspectFit
PreserveAspectCrop
Tile
TileVertically
TileHorizontally
Pad
Shadow
Property
Function
Type
Shadow radius
Sets shadow radius

Actions editor:
Property > Style > DropShadow > Shadow radius
Code:
widget.style.pageItemDropShadowRadius
int
Shadow samples
Sets shadow samples

Actions editor:
Property > Style > DropShadow > Shadow samples
Code:
widget.style.pageItemDropShadowSamples
int
Shadow color
Sets shadow color

Actions editor:
Property > Style > DropShadow > Shadow color
Code:
widget.style.pageItemDropShadowColor
color
Shadow horizontal offset
Sets shadow horizontal offset

Actions editor:
Property > Style > DropShadow > Shadow horizontal offset
Code:
widget.style.pageItemDropShadowHorizontalOffset
double
Shadow vertical offset
Sets shadow vertical offset

Actions editor:
Property > Style > DropShadow > Shadow vertical offset
Code:
widget.style.pageItemDropShadowVerticalOffset
double
Overlay
Property
Function
Type
Overlay color
Sets widget overlay color

Actions editor:
Property > Style > Overlay > Overlay color
Code:
widget.style.pageItemOverlayColor
color
Overlay image
Sets widget overlay image

Actions editor:
Property > Style > Overlay > Overlay image
Code:
widget.style.pageItemOverlayMedia
string
Blend mode
Sets overlay blend mode

Actions editor:
Property > Style > Overlay > Blend mode
Code:
widget.style.pageItemOverlayBlendMode
string

Values:
normal
addition
average
color
colorBurn
colorDodge
darken
darkerColor
difference
divide
exclusion
hardLight
hue
lighten
lighterColor
lightness
multiply
negation
saturation
screen
subtract
softLight
Cached
Enable overlay caching to improve the performance

Actions editor:
Property > Style > Overlay > Cached
Code:
widget.style.pageItemOverlayCached
bool
Overlay fill mode
Sets widget overlay fill mode

Actions editor:
Property > Style > Overlay > Overlay fill mode
Code:
widget.style.pageItemOverlayFillMode
enum

Values:
Stretch
PreserveAspectFit
PreserveAspectCrop
Tile
TileVertically
TileHorizontally
Pad
Margins
Property
Function
Type
Margin left
Sets widget margin left

Actions editor:
Property > Style > Margins > Margin left
Code:
widget.style.pageItemMarginLeft
double
Margin right
Sets widget margin right

Actions editor:
Property > Style > Margins > Margin right
Code:
widget.style.pageItemMarginRight
double
Margin top
Sets widget margin top

Actions editor:
Property > Style > Margins > Margin top
Code:
widget.style.pageItemMarginTop
double
Margin bottom
Sets widget margin bottom

Actions editor:
Property > Style > Margins > Margin bottom
Code:
widget.style.pageItemMarginBottom
double
Blur
Property
Function
Type
Blur mask
Sets widget blur mask image

Actions editor:
Property > Style > Blur > Blur mask
Code:
widget.style.pageItemEffectMedia
string
Blur size
Sets widget blur strength

Actions editor:
Property > Style > Blur > Blur size
Code:
widget.style.pageItemEffectStrength
int
Blur mask fill mode
Sets widget blur mask fill mode

Actions editor:
Property > Style > Blur > Blur mask fill mode
Code:
widget.style.pageItemEffectFillMode
enum

Values:
Stretch
PreserveAspectFit
PreserveAspectCrop
Tile
TileVertically
TileHorizontally
Pad
Playback
Property-Style-Playback
Property
Function
Type
Show playback
Determines when to display playback bar

Actions editor:
Property > Style > Playback > Show playback
Code:
widget.style.pageItemControls
enum

Values:
Maximize
Always
Never
Playback background
Sets playback bar background color

Actions editor:
Property > Style > Playback > Playback background
Code:
widget.style.pageItemToolbarBackgroundColor
color
Controls color
Sets playback controls color

Actions editor:
Property > Style > Playback > Controls color
Code:
widget.style.pageItemToolbarButtonColor
color
Height
Sets playback bar height

Actions editor:
Property > Style > Playback > Height
Code:
widget.style.pageItemToolbarHeight
double
Slider color
Sets playback bar slider color

Actions editor:
Property > Style > Playback > Slider color
Code:
widget.style.pageItemToolbarSliderColor
color
Blurred
Enable playback bar background blurring

Actions editor:
Property > Style > Playback > Blurred
Code:
widget.style.pageItemToolbarBlurred
bool
Controls
Property
Function
Type
Color
Sets element color

Actions editor:
Property > Style > Controls > Color
Code:
widget.style.controlColor
color
Selected color
Sets selected state color

Actions editor:
Property > Style > Controls > Selected color
Code:
widget.style.controlSelectedColor
color
Border color
Sets border color

Actions editor:
Property > Style > Controls > Border color
Code:
widget.style.controlBorderColor
color
Selected border color
Sets selected state border color

Actions editor:
Property > Style > Controls > Selected border color
Code:
widget.style.controlBorderSelectedColor
color
Border size
Sets border size

Actions editor:
Property > Style > Controls > Border size
Code:
widget.style.controlBorderSize
int
Border radius
Sets border radius

Actions editor:
Property > Style > Controls > Border radius
Code:
widget.style.controlRadius
int
Selected font
Sets selected state font color

Actions editor:
Property > Style > Controls > Selected font
Code:
widget.style.controlSelectedFontColor
color
Image position
Sets image position relative to the text label

Actions editor:
Property > Style > Controls > Image position
Code:
widget.style.controlButtonImagePlace
enum

Values:
Qt::AlignTop
Qt::AlignLeft
Qt::AlignRight
Qt::AlignBottom
Image size
Sets image size relative to the text label

Actions editor:
Property > Style > Controls > Image size
Code:
widget.style.controlButtonImageSize
double
Image padding
Sets image padding

Actions editor:
Property > Style > Controls > Image padding
Code:
widget.style.controlButtonImagePadding
double
Slider color
Slider (or switch) thumb color

Actions editor:
Property > Style > Controls > Slider color
Code:
widget.style.controlSliderColor
color
Selected slider color
Sets selected state slider color

Actions editor:
Property > Style > Controls > Selected slider color
Code:
widget.style.controlSliderSelectedColor
color
Slider size
Sets slider (or switch) track size relative to the thumb size

Actions editor:
Property > Style > Controls > Slider size
Code:
widget.style.controlSliderSize
double
Visible items
Sets number of visible items in the tumbler

Actions editor:
Property > Style > Controls > Visible items
Code:
widget.style.controlTumblerVisible
int
Over color
Sets element color on mouse entered

Actions editor:
Property > Style > Controls > Over color
Code:
widget.style.controlOverColor
color
Over border color
Sets element border color on mouse entered

Actions editor:
Property > Style > Controls > Over border color
Code:
widget.style.controlOverBorderColor
color
Over font color
Sets element font color on mouse entered

Actions editor:
Property > Style > Controls > Over font color
Code:
widget.style.controlOverFontColor
color
Over slider color
Sets element slider color on mouse entered

Actions editor:
Property > Style > Controls > Over slider color
Code:
widget.style.controlOverSliderColor
color
Over control colorize
Sets over element colorize

Actions editor:
Property > Style > Controls > Over control colorize
Code:
widget.style.controlOverColorize
color
Interaction
Property
Function
Type
Maximizable
Enable maximizing to page on press

Actions editor:
Property > Interaction > Maximizable
Code:
widget.maximizable
bool
Interactive
Enable user interaction with the widget content

Actions editor:
Property > Interaction > Interactive
Code:
widget.interactive
bool
Input
Enable input actions like Press, Click, Double Click

Actions editor:
Property > Interaction > Input
Code:
widget.action
bool
Fixed
Disable free widget dragging

Actions editor:
Property > Interaction > Fixed
Code:
widget.fixed
bool
Lock size
Enable to lock widget size while dragging

Actions editor:
Property > Interaction > Lock size
Code:
widget.lockSize
bool
Lock rotation
Enable to lock widget rotation while dragging

Actions editor:
Property > Interaction > Lock rotation
Code:
widget.lockRotation
bool
Lock x
Enable to lock x position while dragging

Actions editor:
Property > Interaction > Lock x
Code:
widget.lockX
bool
Lock y
Enable to lock y position while dragging

Actions editor:
Property > Interaction > Lock y
Code:
widget.lockY
bool
Static
Disable dynamically load and unload widget

Actions editor:
Property > Interaction > Static
Code:
widget.static
bool
Connected table index
Not documented

Actions editor:
Property > Interaction > Connected table index
Code:
widget.connectedTableIndex
int
Connected table row id
Not documented

Actions editor:
Property > Interaction > Connected table row id
Code:
widget.connectedTableRowId
int
Font
Property
Function
Type
Family
Font family name

Actions editor:
Property > Font > Family
Code:
widget.style.font.family
string
Size
Font size

Actions editor:
Property > Font > Size
Code:
widget.style.font.size
int
Color
Font color

Actions editor:
Property > Font > Color
Code:
widget.style.font.color
color
Underline
Sets text underline

Actions editor:
Property > Font > Underline
Code:
widget.style.font.underline
bool
Italic
Sets text italic

Actions editor:
Property > Font > Italic
Code:
widget.style.font.italic
bool
Weight
Sets font weight

Actions editor:
Property > Font > Weight
Code:
widget.style.font.weight
enum

Values:
Thin
ExtraLight
Light
Normal
Medium
DemiBold
Bold
ExtraBold
Black
Capitalization
Sets capitalization for text

Actions editor:
Property > Font > Capitalization
Code:
widget.style.font.capitalization
enum

Values:
MixedCase
AllUppercase
AllLowercase
SmallCaps
Capitalize
Letterspacing
Spacing between individual letters

Actions editor:
Property > Font > Letterspacing
Code:
widget.style.font.letterspacing
double
Horizontal
Horizontal alignment of text

Actions editor:
Property > Font > Horizontal
Code:
widget.style.font.horizontalAlignment
enum

Values:
Qt::AlignLeft
Qt::AlignRight
Qt::AlignHCenter
Qt::AlignJustify
Vertical
Vertical alignment of text

Actions editor:
Property > Font > Vertical
Code:
widget.style.font.verticalAlignment
enum

Values:
Qt::AlignTop
Qt::AlignBottom
Qt::AlignVCenter
Wrap
Wrap text to the widget's width

Actions editor:
Property > Font > Wrap
Code:
widget.style.font.wrapMode
enum

Values:
NoWrap
WordWrap
WrapAnywhere
Line height mode
Determines how the line height is specified, proportional to the line or fixed

Actions editor:
Property > Font > Line height mode
Code:
widget.style.font.lineHeightMode
int

Values:
0 - Proportional height
1 - Fixed height
Line height
Sets line height

Actions editor:
Property > Font > Line height
Code:
widget.style.font.lineHeight
int
Database
Property
Function
Type
Database
Database file name

Actions editor:
Property > Database > Database
Code:
widget.database
string
Field index
Current field index

Actions editor:
Property > Database > Field index
Code:
widget.dbFieldNum
int
Field name
Current field name

Actions editor:
Property > Database > Field name
Code:
widget.dbFieldName
string
Rows count
Number of rows in table

Actions editor:
Property > Database > Rows count
Code:
widget.dbRowCount
int
Selected rows count
Number of selected rows

Actions editor:
Property > Database > Selected rows count
Code:
widget.dbSelectedRowCount
int
Last row index
Index of last row

Actions editor:
Property > Database > Last row index
Code:
widget.dbRowLast
int
Row id
Current row id

Actions editor:
Property > Database > Row id
Code:
widget.dbRowId
string
Sql query
Sql query

Actions editor:
Property > Database > Sql query
Code:
widget.sqlQuery
string
Parse query id
Parse query id

Actions editor:
Property > Database > Parse query id
Code:
widget.parseQueryId
string
Actions
Property
Function
Show controls
Show playback panel

Actions editor:
Actions > Common > Show controls
Code:
widget.script.actionShowControls()
Hide controls
Hide playback panel

Actions editor:
Actions > Common > Hide controls
Code:
widget.script.actionHideControls()
Execute
Execute custom script

Actions editor:
Actions > Common > Execute
Code:
widget.script.actionExecute(QString code)
Set db value by field num
Add or modify row by field num. Use row index -1 to add new row, 0 to change last added row

Actions editor:
Actions > Common > Set db value by field num
Code:
widget.script.actionSetValue(int row, int col, QString value)
Set db value by field name
Add or modify row by field name. Use row index -1 to add new row, 0 to change last added row

Actions editor:
Actions > Common > Set db value by field name
Code:
widget.script.actionSetValueByName(int row, QString fieldName, QString value)
Set db value by field name from JSON
Add or modify row by field name from a json object. Empty row id will add new row. Example: {"field1":"field1 value","field2":"field2 value"}

Actions editor:
Actions > Common > Set db value by field name from JSON
Code:
widget.script.actionCommitData(QString rowId, QString dataJson)
Set db value by field num from JSON
Add or modify row by field num from a json object. Empty row id will add new row. Example: {"1":"field1 value","2":"field2 value"}

Actions editor:
Actions > Common > Set db value by field num from JSON
Code:
widget.script.actionCommitDataByNum(QString rowId, QString dataJson)
Add db row
Actions editor:
Actions > Common > Add db row
Code:
widget.script.actionAddRow()
Remove db row
Actions editor:
Actions > Common > Remove db row
Code:
widget.script.actionRemoveRow(QString rowId)
Remove all db rows
Actions editor:
Actions > Common > Remove all db rows
Code:
widget.script.actionRemoveAllRows()
Update database
Actions editor:
Actions > Common > Update database
Code:
widget.script.actionUpdateDatabase()
Set current db row id
Actions editor:
Actions > Common > Set current db row id
Code:
widget.script.actionSetDatabaseRowId(QString rowId)
Share file
Actions editor:
Actions > Common > Share file
Code:
widget.script.actionShareFile()
Set position
Set item x and y position, 0 is top-left side of parent, 1 is bottom-right side of parent

Actions editor:
Actions > Animation > Set position
Code:
widget.script.actionSetPosition(double newX, double newY)
widget.script.actionSetPositionWithAnimation(double newX, double newY, int animationType, int animationDuration)
Set size
Set item width and height, 1 to fill parent width or height

Actions editor:
Actions > Animation > Set size
Code:
widget.script.actionSetSize(double newWidth, double newHeight)
widget.script.actionSetSizeWithAnimation(double newWidth, double newHeight, int animationType, int animationDuration)
Set size and position
Set item size and position, where lt is distance from parent top-left to item top-left, rb is distance from parent bottom-right to item bottom-right

Actions editor:
Actions > Animation > Set size and position
Code:
widget.script.actionSetSizeAndPosition(double lt, double rb)
widget.script.actionSetSizeAndPositionWithAnimation(double lt, double rb, int animationType, int animationDuration)
Set size and position cancel
Reset item size and position

Actions editor:
Actions > Animation > Set size and position cancel
Code:
widget.script.actionSetSizeAndPositionCancel()
widget.script.actionSetSizeAndPositionCancelWithAnimation(int animationType, int animationDuration)
Bring to front
Bring item to front of all items

Actions editor:
Actions > Common > Bring to front
Code:
widget.script.actionBringToFront()
Send to back
Send item to back of all items

Actions editor:
Actions > Common > Send to back
Code:
widget.script.actionSendToBack()
Events
Property
Function
Changed
Event when any property is changed

Actions editor:
Event > Changed
Code:
widget.script.eventChanged()
Database updated
Event when database is updated

Actions editor:
Event > Database updated
Code:
widget.script.eventDatabaseUpdated()
Database rows count
Event when database rows count changed

Actions editor:
Event > Database rows count
Code:
widget.script.eventDatabaseRowsCount()
Database data changed
Event when database data is changed

Actions editor:
Event > Database data changed
Code:
widget.script.eventDatabaseData()
Toggled maximizing
Event when the item is maximized or minimized

Actions editor:
Event > Toggled maximizing
Code:
widget.script.eventToggleExpand()
Maximized
Event when item is maximized

Actions editor:
Event > Maximized
Code:
widget.script.eventExpand()
Minimized
Event when item is minimized

Actions editor:
Event > Minimized
Code:
widget.script.eventShrink()
Hide
Event when item is hidden

Actions editor:
Event > Hide
Code:
widget.script.eventHided()
Show
Event when item is shown

Actions editor:
Event > Show
Code:
widget.script.eventShowed()
Toggle visibility
Event when visibility is toggled

Actions editor:
Event > Toggle visibility
Code:
widget.script.eventToggleVisible()
Press
Event when mouse/touch is pressed

Actions editor:
Event > Press
Code:
widget.script.eventItemPressed()
Click
Event when mouse/touch is released

Actions editor:
Event > Click
Code:
widget.script.eventItemClicked()
Double click
Event when double clicked

Actions editor:
Event > Double click
Code:
widget.script.eventItemDoublePressed()
Mouse over
Event when mouse over widget

Actions editor:
Event > Mouse over
Code:
widget.script.eventMouseOver()
Mouse out
Event when mouse out widget

Actions editor:
Event > Mouse out
Code:
widget.script.eventMouseOut()
Loaded
Event when item loaded

Actions editor:
Event > Loaded
Code:
widget.script.eventLoaded()
Swipe left
Event when swipe left

Actions editor:
Event > Swipe left
Code:
widget.script.eventSwipeLeft()
Swipe right
Event when swipe right

Actions editor:
Event > Swipe right
Code:
widget.script.eventSwipeRight()
Swipe up
Event when swipe up

Actions editor:
Event > Swipe up
Code:
widget.script.eventSwipeUp()
Group
Image
Last modified 1yr ago
Copy link
Contents