Flipabit
Search…
Flipabit
Flipabit
Getting started
Layers
Pages
Widgets
Groups
Style
Interactivity
Project
Animation
Actions
Networking
Tutorials
API
Project
Page
Group
Widget
⭐
Updates
🎁
Get Flipabit
Powered By GitBook
Project
Property
Function
Type
Current page title
Gets current page title Actions editor: Property > Project > Current page title Code: document.currentPageTitle
string
Current page number
Gets current page number Actions editor: Property > Project > Current page number Code: document.currentPageNumber
int
Previous page title
Gets previous page title Actions editor: Property > Project > Previous page title Code: document.prevPageTitle
string
Previous page number
Gets previous page number Actions editor: Property > Project > Previous page number Code: document.prevPageNumber
int
Count pages
Gets count of pages Actions editor: Property > Project > Count pages Code: document.countPages
int
Is page changing
Gets true if page animation is in progress Actions editor: Property > Project > Is page changing Code: document.pageChanging
bool
Maximized title
Gets maximized widget title Actions editor: Property > Project > Maximized title Code: document.maximizedTitle
string
Inactivity time
Gets inactivity time in seconds Actions editor: Property > Project > Inactivity time Code: document.inactivity
int
Timestamp
Gets timestamp (number of seconds since 1970-01-01T00:00:00 Universal Coordinated Time). Actions editor: Property > Project > Timestamp Code: document.timeNumber
int
Time string
Gets formatted time HH:MM:SS Actions editor: Property > Project > Time string Code: document.timeString
string
Date time
Gets formatted datetime YYYY-MM-DD HH:MM:SS Actions editor: Property > Project > Date time Code: document.dateTime
string
Day
Gets current day (1 to 31) Actions editor: Property > Project > Day Code: document.currentDay
int
Day of week
Gets current day of the week (1 = Monday to 7 = Sunday) Actions editor: Property > Project > Day of week Code: document.currentDayOfWeek
int
Month
Gets current month (1 to 12) Actions editor: Property > Project > Month Code: document.currentMonth
int
Year
Gets current year Actions editor: Property > Project > Year Code: document.currentYear
int
Have maximized item
Gets true if there is maximized widget Actions editor: Property > Project > Have maximized item Code: document.haveExpandedItem
bool
Pressed key
Gets last pressed key Actions editor: Property > Project > Pressed key Code: document.pressedKey
int
Released key
Gets last released key Actions editor: Property > Project > Released key Code: document.releasedKey
int
Hold key
Gets last hold key Actions editor: Property > Project > Hold key Code: document.holdKey
int

Settings

Property
Function
Type
Width
Screen width
int
Height
Screen height
int
Orientation
Screen orientation Actions editor: Property > Project > Settings > Orientation Code: document.allowOrientation
enum Values: Both Landscape Portrait
Blur
Blur effect when flipping pages or maximizing widgets Actions editor: Property > Project > Settings > Blur Code: document.blurEnabled
bool
Cursor
Display cursor Actions editor: Property > Project > Settings > Cursor Code: document.showCursor
bool
Asynchronous
Enable asynchronous loading
bool
Load on demand
Enable loading on demand
bool
Page image cache
Enable page image cache
bool
Screensaver
Interval for automatic page change when idle Actions editor: Property > Project > Settings > Screensaver Code: document.screensaverActivationTime
int
Volume
Holds the audio volume from 0 (silence) to 100 (full volume) Actions editor: Property > Project > Settings > Volume Code: document.volume
int

Status bar

Property
Function
Type
Statusbar
Display status bar Actions editor: Property > Project > Settings > Status bar > Statusbar Code: document.settings.statusBarVisibility
bool
Dark
Enable dark text of status bar Actions editor: Property > Project > Settings > Status bar > Dark Code: document.settings.statusBarDarkText
bool
Background
Status bar background color Actions editor: Property > Project > Settings > Status bar > Background Code: document.settings.statusBarColor
color

Mouse trail

Property
Function
Type
Show trail
Display trails from touches or gestures (only for Desktop apps) Actions editor: Property > Project > Settings > Mouse trail > Show trail Code: document.particlesVisible
bool
Color
Trail color Actions editor: Property > Project > Settings > Mouse trail > Color Code: document.particlesColor
color
Random
Enable random trail color Actions editor: Property > Project > Settings > Mouse trail > Random Code: document.particlesRandomColor
bool
Size
Trail size in pixels Actions editor: Property > Project > Settings > Mouse trail > Size Code: document.particlesSize
int

Animation

Interaction

Property
Function
Type
Drag area
Drag area size: margins only or all widget area. Actions editor: Property > Project > Animation > Interaction > Drag area Code: document.settings.floatingBlocks
enum Values: 1 - Margins only 2 - Entire widget
Turning area
Size of screen edges that allow turning the pages Actions editor: Property > Project > Animation > Interaction > Turning area Code: document.settings.turningAreaSize
double

Default animation

Property
Function
Type
Maximize animation
Maximize animation style Actions editor: Property > Project > Animation > Maximize > Maximize animation Code: document.settings.blockResizeAnimation
enum Values: QEasingCurve::Linear QEasingCurve::InQuad QEasingCurve::OutQuad QEasingCurve::InOutQuad QEasingCurve::OutInQuad QEasingCurve::InCubic QEasingCurve::OutCubic QEasingCurve::InOutCubic QEasingCurve::OutInCubic QEasingCurve::InQuart QEasingCurve::OutQuart QEasingCurve::InOutQuart QEasingCurve::OutInQuart QEasingCurve::InQuint QEasingCurve::OutQuint QEasingCurve::InOutQuint QEasingCurve::OutInQuint QEasingCurve::InSine QEasingCurve::OutSine QEasingCurve::InOutSine QEasingCurve::OutInSine QEasingCurve::InExpo QEasingCurve::OutExpo QEasingCurve::InOutExpo QEasingCurve::OutInExpo QEasingCurve::InCirc QEasingCurve::OutCirc QEasingCurve::InOutCirc QEasingCurve::OutInCirc QEasingCurve::InElastic QEasingCurve::OutElastic QEasingCurve::InOutElastic QEasingCurve::OutInElastic QEasingCurve::InBack QEasingCurve::OutBack QEasingCurve::InOutBack QEasingCurve::OutInBack QEasingCurve::InBounce QEasingCurve::OutBounce QEasingCurve::InOutBounce QEasingCurve::OutInBounce
Duration
Maximize animation duration in milliseconds Actions editor: Property > Project > Animation > Maximize > Duration Code: document.settings.blockResizeDuration
int

Page animation

Property
Function
Type
Page animation
Page animation style Actions editor: Property > Project > Animation > Page > Page animation Code: document.settings.pageChangerType
enum Values: 0 - Flip 2 - Swipe 3 - Transition 4 - Scale 5 - Card
Duration
Page animation duration Actions editor: Property > Project > Animation > Page > Duration Code: document.settings.pageChangingDuration
int
Shadow
Display shadow Actions editor: Property > Project > Animation > Page > Shadow Code: document.settings.pageChangerShadow
bool
Animate navigation
Animate navigation layer Actions editor: Property > Project > Animation > Page > Animate navigation Code: document.settings.navigationAnimated
bool
Direction
Animation direction Actions editor: Property > Project > Animation > Page > Direction Code: document.settings.pageChangerSwipeDirection
enum Values: SwipeLeftToRight SwipeTopToBottom
Transition
Transition style Actions editor: Property > Project > Animation > Page > Transition Code: document.settings.pageChangerVideoMaskType
enum Values: VideoMaskArrows VideoMaskBurn VideoMaskCards VideoMaskCircles VideoMaskDrip VideoMaskDynamic VideoMaskShatter VideoMaskSpiral VideoMaskStripes

Publish

Property
Function
Type
Fill mode
Defines what happens when the device screen resolution has a different size. Actions editor: Property > Project > Publish > Fill mode Code: document.ratioFillMode
enum Values: Stretch Fit Pad
Vertical
Vertical alignment Actions editor: Property > Project > Publish > Vertical Code: document.ratioAnchorsVertical
int Values: Qt::AlignTop Qt::AlignBottom Qt::AlignVCenter
Horizontal
Horizontal alignment Actions editor: Property > Project > Publish > Horizontal Code: document.ratioAnchorsHorizontal
int Values: Qt::AlignLeft Qt::AlignRight Qt::AlignHCenter
Fullscreen maximize
Maximize widgets to fullscreen regardless of the fill mode Actions editor: Property > Project > Publish > Fullscreen maximize Code: document.ratioExpanded
bool
Fullscreen background
Fit page background image to fullscreen regardless of the fill mode Actions editor: Property > Project > Publish > Fullscreen background Code: document.ratioBackground
bool
Scale fonts
Scale fonts Actions editor: Property > Project > Publish > Scale fonts Code: document.ratioFont
bool
Window type
Sets window type of exported project. Possible values are: Fullscreen, Maximized or Fixed sized
int
Force project size
Enable fullscreen on multiple monitors
bool
Window title
Sets window title of exported project
string
Start page
Sets start page of exported project
int
Google analytics
Sets Google Analytics Id (GA_TRACKING_ID)
string
Rotate maximized item
Enable to allow rotation of maximized item Actions editor: Property > Project > Publish > Rotate maximized item Code: document.rotateMaximized
bool
Video renderer
Sets video renderer (for Windows only)
string

Sensors

Accelerometer

Property
Function
Type
AccelerometerX
Gets acceleration on the X axis Actions editor: Property > Project > Sensors > Accelerometer > AccelerometerX Code: document.accelerometerX
double
AccelerometerY
Gets acceleration on the Y axis Actions editor: Property > Project > Sensors > Accelerometer > AccelerometerY Code: document.accelerometerY
double
AccelerometerZ
Gets acceleration on the Z axis Actions editor: Property > Project > Sensors > Accelerometer > AccelerometerZ Code: document.accelerometerZ
double
Accelerometer
Enable accelerometer sensor Actions editor: Property > Project > Sensors > Accelerometer > Accelerometer Code: document.accelerometerEnabled
bool

Ambient

Property
Function
Type
Ambient light
Gets ambient light level Actions editor: Property > Project > Sensors > Ambient > Ambient light Code: document.ambientLightSensorLevel
int
Ambient temperature
Gets ambient temperature in degree Celsius Actions editor: Property > Project > Sensors > Ambient > Ambient temperature Code: document.ambientTemperatureSensorTemperature
double
Light (amb)
Enable ambient light sensor Actions editor: Property > Project > Sensors > Ambient > Light (amb) Code: document.ambientLightSensorEnabled
bool
Temperature (amb)
Enable ambient temperature sensor Actions editor: Property > Project > Sensors > Ambient > Temperature (amb) Code: document.ambientTemperatureSensorEnabled
bool

Compass

Property
Function
Type
Compass azimuth
Gets azimuth of the device Actions editor: Property > Project > Sensors > Compass > Compass azimuth Code: document.compassAzimuth
double
Compass
Enable compass sensor Actions editor: Property > Project > Sensors > Compass > Compass Code: document.compassEnabled
bool

Gyroscope

Property
Function
Type
Gyroscope x
Gets angular velocity around the x axis Actions editor: Property > Project > Sensors > Gyroscope > Gyroscope x Code: document.gyroscopeX
double
Gyroscope y
Gets angular velocity around the y axis Actions editor: Property > Project > Sensors > Gyroscope > Gyroscope y Code: document.gyroscopeY
double
Gyroscope z
Gets angular velocity around the z axis Actions editor: Property > Project > Sensors > Gyroscope > Gyroscope z Code: document.gyroscopeZ
double
Gyroscope
Enable gyroscope sensor Actions editor: Property > Project > Sensors > Gyroscope > Gyroscope Code: document.gyroscopeEnabled
bool

Light

Property
Function
Type
Light illuminance
Gets light level Actions editor: Property > Project > Sensors > Light > Light illuminance Code: document.lightSensorIlluminance
double
Light
Enable light sensor Actions editor: Property > Project > Sensors > Light > Light Code: document.lightSensorEnabled
bool

Magnetometer

Property
Function
Type
Magnetometer x
Gets raw magnetic flux density on the X axis Actions editor: Property > Project > Sensors > Magnetometer > Magnetometer x Code: document.magnetometerX
double
Magnetometer y
Gets raw magnetic flux density on the Y axis Actions editor: Property > Project > Sensors > Magnetometer > Magnetometer y Code: document.magnetometerY
double
Magnetometer z
Gets raw magnetic flux density on the Z axis Actions editor: Property > Project > Sensors > Magnetometer > Magnetometer z Code: document.magnetometerZ
double
Magnetometer
Enable magnetometer sensor Actions editor: Property > Project > Sensors > Magnetometer > Magnetometer Code: document.magnetometerEnabled
bool

Orientation

Property
Function
Type
Orientation value
Gets orientation of the device 0 - The orientation is unknown. 1 - The Top edge of the device is pointing up. 2 - The Top edge of the device is pointing down. 3 - The Left edge of the device is pointing up. 4 - The Right edge of the device is pointing up. 5 - The Face of the device is pointing up. 6 - The Face of the device is pointing down. Actions editor: Property > Project > Sensors > Orientation > Orientation value Code: document.orientationSensorOrientation
int
Orientation
Enable orientation sensor Actions editor: Property > Project > Sensors > Orientation > Orientation Code: document.orientationSensorEnabled
bool

Pressure

Property
Function
Type
Pressure value
Gets atmospheric pressure value in Pascals Actions editor: Property > Project > Sensors > Pressure > Pressure value Code: document.pressureSensorPressure
double
Pressure temperature
Gets pressure sensor's temperature value in degrees Celsius Actions editor: Property > Project > Sensors > Pressure > Pressure temperature Code: document.pressureSensorTemperature
double
Pressure
Enable pressure sensor Actions editor: Property > Project > Sensors > Pressure > Pressure Code: document.pressureSensorEnabled
bool

Proximity

Property
Function
Type
Proximity value
Gets value indicating if something is near Actions editor: Property > Project > Sensors > Proximity > Proximity value Code: document.proximitySensorNear
bool
Proximity
Enable proximity sensor Actions editor: Property > Project > Sensors > Proximity > Proximity Code: document.proximitySensorEnabled
bool

Rotation

Property
Function
Type
Rotation x
Gets rotation around the x axis Actions editor: Property > Project > Sensors > Rotation > Rotation x Code: document.rotationSensorX
double
Rotation y
Gets rotation around the y axis Actions editor: Property > Project > Sensors > Rotation > Rotation y Code: document.rotationSensorY
double
Rotation z
Gets rotation around the z axis Actions editor: Property > Project > Sensors > Rotation > Rotation z Code: document.rotationSensorZ
double
Rotation
Enable rotation sensor Actions editor: Property > Project > Sensors > Rotation > Rotation Code: document.rotationSensorEnabled
bool

Tilt

Property
Function
Type
Tilt rotation x
Gets amount of tilt on the X axis Actions editor: Property > Project > Sensors > Tilt > Tilt rotation x Code: document.tiltSensorXRotation
double
Tilt rotation y
Gets amount of tilt on the Y axis Actions editor: Property > Project > Sensors > Tilt > Tilt rotation y Code: document.tiltSensorYRotation
double
Tilt
Enable tilt sensor Actions editor: Property > Project > Sensors > Tilt > Tilt Code: document.tiltSensorEnabled
bool

Actions

Property
Function
Go to page
Open page by id Actions editor: Actions > Go to page Code: document.script.actionShowObjectById(int id)
Go to page number
Open page by number Actions editor: Actions > Go to page number Code: document.script.actionShowObjectByNum(int num)
Next page
Open next page Actions editor: Actions > Next page Code: document.script.actionTurnForward()
Prev page
Open prev page Actions editor: Actions > Prev page Code: document.script.actionTurnBackward()
Execute
Execute custom script Actions editor: Actions > Execute Code: document.script.actionExecute(QString code)
Quit
Close application Actions editor: Actions > Quit Code: document.script.actionQuit()
Rotate
Rotate the screen by 180 degree Actions editor: Actions > Rotate Code: document.script.actionRotate()
Print
Print current page on default printer Actions editor: Actions > Print Code: document.script.actionPrint()
Minimize all
Minimize all maximized items Actions editor: Actions > Minimize all Code: document.script.actionShrinkAll()
Stop all media
Stop playing all media Actions editor: Actions > Stop all media Code: document.script.actionStopAll()
Save as image
Save current page as image to default Documents folder Actions editor: Actions > Save as image Code: document.script.actionSaveAsImage(QString fileName)
Save text to file
Save text to the file created in Documents folder Actions editor: Actions > Save text to file Code: document.script.actionSaveToFile(QString fileName, QString text, bool overwrite)
Backward
Actions editor: Actions > Backward Code: document.script.actionBackward()
Forward
Actions editor: Actions > Forward Code: document.script.actionForward()
Open Url
If the specified URL scheme is handled by another app, OS launches that app and passes the URL to it. Actions editor: Actions > Open Url Code: document.script.actionOpenUrl(QString url)
Unload unused pages
Unload pages, keep in memory only current page Actions editor: Actions > Unload unused pages Code: document.script.actionUnloadUnusedPages()
Open camera picker
Actions editor: Actions > Open camera picker Code: document.script.actionOpenCameraPicker()
Open photo picker
Actions editor: Actions > Open photo picker Code: document.script.actionOpenPhotoPicker()
Download url
Actions editor: Actions > Download url Code: document.script.actionDownload(QString url)

Events

Property
Function
Changed
Event when any property is changed Actions editor: Event > Changed Code: document.script.eventChanged()
Enter page
Event when any page was opened Actions editor: Event > Enter page Code: document.script.eventEnteredPage()
Leave page
Event when leave any page Actions editor: Event > Leave page Code: document.script.eventLeavedPage()
Open project
Event when project is opened Actions editor: Event > Open project Code: document.script.eventOpenedProject()
Project orientation
Event when project orientation changed Actions editor: Event > Project orientation Code: document.script.eventOrientation()
Screen orientation
Event when device orientation changed Actions editor: Event > Screen orientation Code: document.script.eventScreenOrientation()
Maximized item
Event when any item is maximized Actions editor: Event > Maximized item Code: document.script.eventExpandItem()
Minimized item
Event when any item is minimized Actions editor: Event > Minimized item Code: document.script.eventShrinkItem()
Stop all media
Actions editor: Event > Stop all media Code: document.script.eventStopAll()
Key pressed
Event when key is pressed Actions editor: Event > Key pressed Code: document.script.eventKeyPressed()
Key released
Event when key is released Actions editor: Event > Key released Code: document.script.eventKeyReleased()
Key hold
Event when key is hold Actions editor: Event > Key hold Code: document.script.eventKeyHold()
Back pressed
Event when back is pressed on Android device Actions editor: Event > Back pressed Code: document.script.eventAndroidBackPressed()
Pressed
Event when mouse is pressed on page or widget Actions editor: Event > Pressed Code: document.script.eventPressed()
Clicked
Event when mouse is released on page or widget Actions editor: Event > Clicked Code: document.script.eventClicked()
Mouse moved
Event when mouse is moved on page or widget Actions editor: Event > Mouse moved Code: document.script.eventMouseMoved()
Online status
Event when network connection is changed Actions editor: Event > Online status Code: document.script.eventOnlineStatus()
Mouse over
Event when mouse over page or widget Actions editor: Event > Mouse over Code: document.script.eventMouseOver()
Minimized item end
Event when any item is minimized end Actions editor: Event > Minimized item end Code: document.script.eventShrinkItemEnd()
Previous
API
Next
Page
Last modified 1yr ago
Copy link
Contents
Settings
Status bar
Mouse trail
Animation
Interaction
Default animation
Page animation
Publish
Sensors
Accelerometer
Ambient
Compass
Gyroscope
Light
Magnetometer
Orientation
Pressure
Proximity
Rotation
Tilt
Actions
Events