APIDOX improvements for PlasmaExtras

This commit is contained in:
Sebastian Kügler 2012-03-31 01:20:08 +02:00
parent 3dd6ad6138
commit e747fb6e3b
4 changed files with 92 additions and 31 deletions

View File

@ -26,20 +26,47 @@ Imports:
org.kde.plasma.extras org.kde.plasma.extras
Description: Description:
This is a container for Apps. Navigation and Content area layout can This is a container for Apps. Navigation and Content area layout can vary depending on the
vary depending on the available size. available size. This class can be used as top level Item or inside your top-level item. It
will manage context or navigation area, content area and toolbars in a way consistent with
other apps, and adaptive to the device.
Note that App is experimental, its API might change Note that App is experimental, its API might change.
Example usage:
<pre>import QtQuick 1.1
import org.kde.plasma.core 0.1 as PlasmaCore
import org.kde.plasma.extras 0.1 as PlasmaExtras
PlasmaExtras.App {
id: app
width: 800
height: 600
navigation: navigationItem
content: contentItem
Item {
id: navigationItem
// [...] this is the navigation area
}
Loader {
id: contentItem
source: "gallery/Extras.qml"
parent: contentArea
}
}</pre>
Properties: Properties:
Item navigation: Navigation or Context Area. Item navigation:
Item content: The "main view" Navigation or Context Area.
ToolBarLayout tools: alias to the topBar's ToolBar.tools
Methods: Item content:
The "main view"
ToolBarLayout tools:
Signals: alias to the topBar's ToolBar.tools
**/ **/

View File

@ -26,24 +26,35 @@ Imports:
org.kde.plasma.extras org.kde.plasma.extras
Description: Description:
This is a title label which uses the plasma theme. This is a heading label used for subsections of texts.
The characteristics of the text will be automatically set The characteristics of the text will be automatically set according to the plasma theme. Use
according to the plasma theme. Use this components for titles this components for section titles or headings in your UI, for example page or section titles.
in your UI, for example page or section titles.
Example usage:
<code>
import org.kde.plasma.extras 0.1 as PlasmaExtras
[...]
Column{
PlasmaExtras.Title { text: "Fruit sweetness on the rise" }
PlasmaExtras.Heading { text: "Apples in the sunlight"; level: 2 }
PlasmaExtras.Paragraph { text: "Long text about fruit and apples [...]" }
[...]
}
</code>
See Plasma Component's Label and primitive QML Text element API for additional properties,
methods and signals.
Properties: Properties:
string text: string text:
The most important property is "text", which applies to the text property of Label The most important property is "text", which applies to the text property of Label
For the other ones see Plasma Component's Label or QML primitive Text element For the other ones see Plasma Component's Label or QML primitive Text element
int level: int level:
The level determines how big the section header is display, values between 1 (big) The level determines how big the section header is display, values between 1 (big)
and 5 (small) are accepted and 5 (small) are accepted
Methods:
See Plasma Component's Label and primitive QML Text element
Signals:
See Plasma Component's Label and primitive QML Text element
**/ **/
import QtQuick 1.1 import QtQuick 1.1

View File

@ -26,21 +26,35 @@ Imports:
org.kde.plasma.extras org.kde.plasma.extras
Description: Description:
This is a paragraph label which uses the plasma theme. This is a paragraph Label which uses the plasma theme. The characteristics of the text will
The characteristics of the text will be automatically set be automatically set according to the plasma theme. Use this components for paragraphs
according to the plasma theme. Use this components for paragraphs of text in your application. Use this component for blocks of text in your app.
of text in your application.
Example usage:
<code>
import org.kde.plasma.extras 0.1 as PlasmaExtras
[...]
Column{
PlasmaExtras.Title { text: "Fruit sweetness on the rise" }
PlasmaExtras.Heading { text: "Apples in the sunlight"; level: 2 }
PlasmaExtras.Paragraph { text: "Long text about fruit and apples [...]" }
[...]
}
</code>
See Plasma Component's Label and primitive QML Text element API for additional properties,
methods and signals.
Properties: Properties:
string text: string text:
The most important property is "text", which applies to the text property of Label The most important property is "text", which applies to the text property of Label
For the other ones see Plasma Component's Label or QML primitive Text element For the other ones see Plasma Component's Label or QML primitive Text element
int level: int level:
The level determines how big the section header is display, values between 1 (big) The level determines how big the section header is display, values between 1 (big)
and 5 (small) are accepted and 5 (small) are accepted
Methods: Methods:
See Plasma Component's Label and primitive QML Text element
Signals: Signals:
See Plasma Component's Label and primitive QML Text element See Plasma Component's Label and primitive QML Text element

View File

@ -23,7 +23,7 @@ Inherits:
Imports: Imports:
QtQuick 1.1 QtQuick 1.1
org.kde.plasma.components org.kde.plasma.components 0.1
Description: Description:
This is a title label which uses the plasma theme. This is a title label which uses the plasma theme.
@ -31,16 +31,25 @@ Description:
according to the plasma theme. Use this components for titles according to the plasma theme. Use this components for titles
in your UI, for example page or section titles. in your UI, for example page or section titles.
Example usage:
<code>
import org.kde.plasma.extras 0.1 as PlasmaExtras
[...]
Column{
PlasmaExtras.Title { text: "Fruit sweetness on the rise" }
PlasmaExtras.Heading { text: "Apples in the sunlight"; level: 2 }
PlasmaExtras.Paragraph { text: "Long text about fruit and apples [...]" }
[...]
}
</code>
See Plasma Component's Label and primitive QML Text element API for additional properties,
methods and signals.
Properties: Properties:
string text: string text:
The most important property is "text", which applies to the text property of Label The most important property is "text", which applies to the text property of Label
For the other ones see Plasma Component's Label or QML primitive Text element For the other ones see Plasma Component's Label or QML primitive Text element
Methods:
See Plasma Component's Label and primitive QML Text element
Signals:
See Plasma Component's Label and primitive QML Text element
**/ **/
import QtQuick 1.1 import QtQuick 1.1