# Page
To access the property from outside:
```
document.childByName("Page 1").PROPERTY_NAME
```
To access the property from the page:
```
page.PROPERTY_NAME
```
For example, to change page background color on click the button:
```
import QtQuick 2.5
Item {
Connections {
target: document.childByName("Button 1").scriptAdaptor
onEventItemClicked: {
document.childByName("Page 1").style.blockBackgroundColor = "#ff0000"
}
}
}
```
## Interaction
| Property | Function | Type |
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ |
| Static | Sets static page
Actions editor:
Property > Page > Interaction > Static
Code:
page.isStatic
| `bool` |
| Have maximized item | Gets true if there is maximized widget on page
Actions editor:
Property > Page > Interaction > Have maximized item
Code:
page.haveExpandedItem
| `bool` |
## Style
### Background
| Property | Function | Type |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Background color | Sets page background color
Actions editor:
Property > Page > Style > Background > Background color
Code:
page.style.pageBackgroundColor
| `color` |
| Background image | Sets page background image
Actions editor:
Property > Page > Style > Background > Background image
Code:
page.style.pageBackgroundMedia
| `string` |
| Background fill mode | Sets page background fill mode
Actions editor:
Property > Page > Style > Background > Background fill mode
Code:
page.style.pageBackgroundFillMode
| enum
Values:
Stretch
PreserveAspectFit
PreserveAspectCrop
Tile
TileVertically
TileHorizontally
Pad
|
### Overlay
| Property | Function | Type |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Overlay image | Sets page overlay image
Actions editor:
Property > Page > Style > Overlay > Overlay image
Code:
page.style.pageOverlayMedia
| `string` |
| Overlay fill mode | Sets page overlay fill mode
Actions editor:
Property > Page > Style > Overlay > Overlay fill mode
Code:
page.style.pageOverlayFillMode
| enum
Values:
Stretch
PreserveAspectFit
PreserveAspectCrop
Tile
TileVertically
TileHorizontally
Pad
|
### Icon
| Property | Function | Type |
| -------- | -------------- | -------- |
| Icon | Not documented | `string` |
## Actions
| Property | Function |
| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Enter | Manually fire Enter event
Actions editor:
Actions > Enter
Code:
page.script.actionEntered()
|
| Press | Manually fire Press event
Actions editor:
Actions > Press
Code:
page.script.actionItemPressed()
|
| Click | Manually fire Click event
Actions editor:
Actions > Click
Code:
page.script.actionItemClicked()
|
| Double click | Manually fire Double click event
Actions editor:
Actions > Double click
Code:
page.script.actionItemDoublePressed()
|
| Execute | Execute custom script
Actions editor:
Actions > Execute
Code:
page.script.actionExecute(QString code)
|
| Minimize all | Minimize all maximized items
Actions editor:
Actions > Minimize all
Code:
page.script.actionShrinkAll()
|
| Save as image | Save current page as image to default Documents folder
Actions editor:
Actions > Save as image
Code:
page.script.actionSaveAsImage(QString fileName)
|
| Unload page | Unload page
Actions editor:
Actions > Unload page
Code:
page.script.actionUnloadPage()
|
## Events
| Property | Function |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Changed | Event when any property is changed
Actions editor:
Event > Changed
Code:
page.script.eventChanged()
|
| Enter | Event when the page was opened
Actions editor:
Event > Enter
Code:
page.script.eventEntered()
|
| Leave | Event when leave the page
Actions editor:
Event > Leave
Code:
page.script.eventLeaved()
|
| Before enter | Event before open page
Actions editor:
Event > Before enter
Code:
page.script.eventBeforeEnter()
|
| Press | Event when mouse is pressed on the page or widget on the page
Actions editor:
Event > Press
Code:
page.script.eventItemPressed()
|
| Click | Event when mouse is released
Actions editor:
Event > Click
Code:
page.script.eventItemClicked()
|
| Double click | Event when double clicked on the page
Actions editor:
Event > Double click
Code:
page.script.eventItemDoublePressed()
|
| Maximized item | Event when page item is maximized
Actions editor:
Event > Maximized item
Code:
page.script.eventExpandItem()
|
| Minimized item | Event when page item is minimized
Actions editor:
Event > Minimized item
Code:
page.script.eventShrinkItem()
|
| Mouse over | Event when mouse over page
Actions editor:
Event > Mouse over
Code:
page.script.eventMouseOver()
|
| Loaded | Event when page loaded
Actions editor:
Event > Loaded
Code:
page.script.eventLoaded()
|
| Swipe left | Event when swipe left
Actions editor:
Event > Swipe left
Code:
page.script.eventSwipeLeft()
|
| Swipe right | Event when swipe right
Actions editor:
Event > Swipe right
Code:
page.script.eventSwipeRight()
|
| Swipe up | Event when swipe up
Actions editor:
Event > Swipe up
Code:
page.script.eventSwipeUp()
|
| Swipe down | Event when swipe down
Actions editor:
Event > Swipe down
Code:
page.script.eventSwipeDown()
|
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.flipabit.dev/api/page.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.