Page QML Type
A page with a header and footer bar, that can be switched among many other features. * * This page has a header and footer bar that by default are a MauiKit ToolBar, * the header bar can be dinamically moved to the bottom under the footer for better * reachability on hand held devices like phones. * * Among other features, the page can have a reference to a flickable element to allow to have pull back * toolbar behaviour, floating toolbars, etc. *. More...
| Import Statement: | import org.mauikit.controls 1.0 |
| Since: | org.mauikit.controls 1.0 |
| Inherited By: | AltBrowser and AppViews |
Properties
- altHeader : bool
- autoHideFooter : bool
- autoHideFooterDelay : int
- autoHideFooterMargins : int
- autoHideHeader : bool
- autoHideHeaderDelay : int
- autoHideHeaderMargins : int
- bottomMargin : int
- content : list<Object>
- flickable : Flickable
- floatingFooter : bool
- floatingHeader : bool
- footBar : ToolBar
- footer : Item
- footerColumn : list<Object>
- footerContainer : alias
- footerPositioning : int
- headBar : ToolBar
- header : Item
- headerColorSet : int
- headerColumn : list<Object>
- headerContainer : alias
- headerPositioning : int
- internalHeight : int
- leftMargin : int
- margins : int
- pageContent : Item
- rightMargin : int
- showCSDControls : bool
- showTitle : bool
- title : string
- topMargin : int
Signals
Methods
Detailed Description
* * *
Property Documentation
* If set to true the header bar will be positioned to the bottom under the footer bar. * This makes sense in some cases for better reachability, or custom design patterns.
* If the footer bar should hide under certain conditions. * To fine tune a threshold margin can be set, and a time delay.
* Span of time to hide the footer bar after the conditions have been met. * If within the span of time the conditions changed then the timer gets reseted.
* Pixels threshold for when the footer should auto hide. * The default value is set to Maui.Style.toolBarHeight, which is the double distance of the default footer bar toolbar.
* If the header bar should hide under certain conditions. * To fine tune a threshold margin can be set, and a time delay.
* Span of time to hide the header bar after the conditions have been met. * If within the span of time the conditions changed then the timer gets reseted.
* Pixels threshold for when the header should auto hide. * The default value is set to Maui.Style.toolBarHeight, which is the double distance of the default header bar toolbar.
* * * The default content of the page. * To position child elements use anchors or do it manually.
* A flickable element can be referenced in order to support the header and footer positioning options * such as Inline, Pullback or floating. * If a flickable is set, the page will modify its top or bottom margins properties. * And watch for changes in properties such a contentX and contentY in order to support the former mentioned features.
* If the header bar should float over the page contents, if a flickable has been set then the default header bar will have a translucent ShaderEffect * to hint about the content under it.
* If the footer bar should float over the page contents, if a flickable has been set then the default header bar will have a translucent ShaderEffect * to hint about the content under it.
footBar : ToolBar |
* * Quick way to add more children to the footer bar. * The footer bar is handled by a ColumnLayout so any elements to be added need to be postioned using the Layout attached properties. * Layout.fillWidth can be set, but an implicit or preferredHeight must be given.
* The footer bar can be place static and always visible with the InlineFooter value, or move with the flickable contents when using the PullBackFooter value. * This is only supported if a flickable element has been set. * By default this is set to InlineFooter.
headBar : ToolBar |
* * Quick way to add more children to the header bar. * The header bar is handled by a ColumnLayout so any elements to be added need to be postioned using the Layout attached properties. * Layout.fillWidth can be set, but an implicit or preferredHeight must be given.
* The header bar can be place static and always visible with the InlineHeader value, or move with the flickable contents when using the PullBackHeader value. * This is only supported if a flickable element has been set. * By default this is set to InlineHeader unless it is a Mobile device, in which case it is PullBackHeader.
* * * The actual height of the page contents withouth the header or footer bars.
* The page margins between the children contents and the actual container. * This margins do not affect the header or footer bars. * By default this is set to 0
* If a title is set and this is set to true, such title will be displayed in the default header bar in the middle.
* A title for the page. * This title is shown in the middle of the default header bar if the showTitle property is set to true. * The displayed title in the header bar wont wrap and will elide in the middle.