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

Doxygenize Tab* components

Browse Source
This commit is contained in:
Aurélien Gâteau 2012-12-17 22:50:33 +01:00
parent 13c9cfc702
commit 536ce38966
3 changed files with 69 additions and 77 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
declarativeimports/plasmacomponents/qml/TabBar.qml
View File

@ -40,40 +40,32 @@
** **
****************************************************************************/ ****************************************************************************/
/**Documented API
Inherits:
DualStateButton
Imports:
QtQuick 1.1
org.kde.plasma.core
Description:
TabBar is a plasma themed component that you can
use as a container for the tab buttons.
Properties:
Item currentTab:
Returns the current tabbar button.
default alias content:
This property represends the the content of
the TabBarLayout.
Item tabBarLayout:
This is an alias for the layout of the tabbar.
**/
import QtQuick 1.1 import QtQuick 1.1
import org.kde.plasma.core 0.1 as PlasmaCore import org.kde.plasma.core 0.1 as PlasmaCore
import "private" as Private import "private" as Private
/**
* TabBar is a plasma-themed component that you can use as a container for
* tab buttons.
*/
FocusScope { FocusScope {
id: root id: root
/**
* type:list<Item>
* The content of the TabBarLayout.
*/
default property alias content: tabBarLayout.data default property alias content: tabBarLayout.data
/**
* type:TabBarLayout
* The layout of the TabBar.
*/
property alias layout: tabBarLayout property alias layout: tabBarLayout
//Plasma extension //Plasma extension
/**
* The current tabbar button.
*/
property Item currentTab property Item currentTab
implicitWidth: layout.implicitWidth + backgroundFrame.margins.left + backgroundFrame.margins.right implicitWidth: layout.implicitWidth + backgroundFrame.margins.left + backgroundFrame.margins.right

63
declarativeimports/plasmacomponents/qml/TabButton.qml
View File

@ -40,55 +40,50 @@
** **
****************************************************************************/ ****************************************************************************/
/**Documented API
Inherits:
Item
Imports:
QtQuick 1.1
AppManager.js
Description:
A simple tab button which is using the plasma theme.
Properties:
Item tab:
The reference to the tab content (one of the children of a TabGroup,
usually a Page) that is activated when this TabButton is clicked.
bool checked:
True if the button is checked,otherwise false.
bool pressed:
True if the button is being pressed,otherwise false.
string text:
Sets the text for the button.
string iconSource:
Icon for the button. It can be a Freedesktop icon name, a full path to a png/svg file,
or any name for which the application has an image handler registered.
Signals:
onClicked:
The signal is emmited when the button is clicked.
**/
import QtQuick 1.1 import QtQuick 1.1
import "private/AppManager.js" as Utils import "private/AppManager.js" as Utils
import org.kde.plasma.core 0.1 as PlasmaCore import org.kde.plasma.core 0.1 as PlasmaCore
/**
* A simple tab button which is using the plasma theme.
*/
Item { Item {
id: root id: root
// Common Public API // Common Public API
/**
* The reference to the tab content (one of the children of a TabGroup,
* usually a Page) that is activated when this TabButton is clicked.
*/
property Item tab property Item tab
/**
* True if the button is checked, false otherwise.
*/
property bool checked: (internal.tabGroup == null) ? (internal.tabBar.currentTab == root) : (internal.tabGroup.currentTab == tab) property bool checked: (internal.tabGroup == null) ? (internal.tabBar.currentTab == root) : (internal.tabGroup.currentTab == tab)
/**
* True if the button is being pressed, false otherwise.
*/
property bool pressed: mouseArea.pressed == true && mouseArea.containsMouse property bool pressed: mouseArea.pressed == true && mouseArea.containsMouse
/**
* type:string
* The text for the button.
*/
property alias text: label.text property alias text: label.text
/**
* type:string
* Icon for the button. It can be a Freedesktop icon name, a full path to a
* png/svg file, or any name for which the application has an image handler
* registered.
*/
property alias iconSource: imageLoader.source property alias iconSource: imageLoader.source
/**
* Emitted when the button is clicked.
*/
signal clicked signal clicked
implicitWidth: label.implicitWidth + (internal.portrait ? 0 : (iconSource != null ? 16 : 0)) implicitWidth: label.implicitWidth + (internal.portrait ? 0 : (iconSource != null ? 16 : 0))

43
declarativeimports/plasmacomponents/qml/TabGroup.qml
View File

@ -38,32 +38,37 @@
** **
****************************************************************************/ ****************************************************************************/
/**Documented API
Inherits:
Item
Imports:
QtQuick 1.1
Description:
Provides a set of pages for a tab-based interface.
A tabbed interface is made up of tab buttons plus content for each button. A TabGroup component has, as its children, each page of content in the interface. These pages can be any QML items but are typically Page components for a single page of content or PageStack components when a hierarchical navigation system is required for the tab content.
If you use Page components for your tab content, the status property of each page is updated appropriately when the current tab is changed: the current page has status PageStatus.Active and other pages have the status PageStatus.Inactive. During page transitions, PageStatus.Activating (for the page that is becoming the current page) and PageStatus.Deactivating (for the page that was the current page) statuses are also set.
Properties:
Item currentTab:
The tab that is currently active and visible to the user.
The currentTab property is initialized to null and is automatically set to point to the first tab when content is added. You can set the currentTab at any time to activate a particular tab.
**/
import QtQuick 1.1 import QtQuick 1.1
import "private/TabGroup.js" as Engine import "private/TabGroup.js" as Engine
import "." 0.1 import "." 0.1
/**
* Provides a set of pages for a tab-based interface.
*
* A tabbed interface is made up of tab buttons plus content for each button. A
* TabGroup component has, as its children, each page of content in the
* interface. These pages can be any QML items but are typically Page
* components for a single page of content or PageStack components when a
* hierarchical navigation system is required for the tab content.
*
* If you use Page components for your tab content, the status property of each
* page is updated appropriately when the current tab is changed: the current
* page has status PageStatus.Active and other pages have the status
* PageStatus.Inactive. During page transitions, PageStatus.Activating (for the
* page that is becoming the current page) and PageStatus.Deactivating (for the
* page that was the current page) statuses are also set.
*/
Item { Item {
id: root id: root
/**
* The tab that is currently active and visible to the user.
*
* The currentTab property is initialized to null and is automatically set
* to point to the first tab when content is added. You can set the
* currentTab at any time to activate a particular tab.
*/
property Item currentTab property Item currentTab
property list<Item> privateContents property list<Item> privateContents