alecs/plasma-framework
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Doxygenize Page

Browse Source
This commit is contained in:
Aurélien Gâteau 2012-12-17 18:47:45 +01:00
parent cd453af5a8
commit 4cf125f4a4
1 changed files with 32 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
declarativeimports/plasmacomponents/qml/Page.qml
View File

@ -38,56 +38,51 @@
**
****************************************************************************/
/**Documented API
Inherits:
Item
Imports:
QtQuick 1.1
everything in the same dir which are version 0.1
Description:
Defines the content of a piece of the user interface, it's meant to be loaded by a PageStack or TabGroup element.
The typical use can be in small plasmoids or mobile devices where the whole screen is a series of interchangeable and flickable pages, of which the user navigates across.
Properties:
* int status:
The current status of the page. It can be one of the following values:
PageStatus.Inactive (default) - the page is not visible.
PageStatus.Activating - the page is becoming to the active page.
PageStatus.Active - the page is the currently active page.
PageStatus.Deactivating - the page is becoming to inactive page.
* PageStack pageStack:
The page stack that this page is owned by.
* int orientationLock:
Sets the orientation for the Page
* Item tools:
Defines the toolbar contents for the page. If the page stack is set up using a toolbar instance, it automatically shows the currently active page's toolbar contents in the toolbar. The default value is null resulting in the page's toolbar to be invisible when the page is active.
**/
import QtQuick 1.1
import "." 0.1
/**
* Defines the content of a piece of the user interface, it's meant to be
* loaded by a PageStack or TabGroup element. The typical use can be in small
* plasmoids or mobile devices where the whole screen is a series of
* interchangeable and flickable pages, of which the user navigates across.
*/
Item {
id: root
// The status of the page. One of the following:
// PageStatus.Inactive - the page is not visible
// PageStatus.Activating - the page is transitioning into becoming the active page
// PageStatus.Active - the page is the current active page
// PageStatus.Deactivating - the page is transitioning into becoming inactive
/**
* type:PageStatus::Status
* The status of the page
*
* One of the following:
*
* - PageStatus.Inactive: the page is not visible
* - PageStatus.Activating: the page is transitioning into becoming the active page
* - PageStatus.Active: the page is the current active page
* - PageStatus.Deactivating: the page is transitioning into becoming inactive
*/
property int status: PageStatus.Inactive
/**
* type:PageStack
* The page stack that this page is owned by.
*/
property Item pageStack
// Defines orientation lock for a page
/**
* Sets the orientation for the Page
*/
property int orientationLock: PageOrientation.Automatic
/**
* Defines the toolbar contents for the page. If the page stack is set up
* using a toolbar instance, it automatically shows the currently active
* page's toolbar contents in the toolbar.
*
* The default value is null resulting in the page's toolbar to be
* invisible when the page is active.
*/
property Item tools: null
visible: false