diff --git a/declarativeimports/plasmacomponents/qml/BusyIndicator.qml b/declarativeimports/plasmacomponents/qml/BusyIndicator.qml index 473263dcc..aa303763d 100644 --- a/declarativeimports/plasmacomponents/qml/BusyIndicator.qml +++ b/declarativeimports/plasmacomponents/qml/BusyIndicator.qml @@ -18,7 +18,7 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ -/**Documentanted API +/**Documented API Inherits: Item @@ -27,7 +27,7 @@ Imports: QtQuick 1.1 Description: - It is just a simple BusyIndicator. + It is just a simple Busy Indicator, it is used to indicate a task which duration is unknown. If the task duration/number of steps is known, a ProgressBar should be used instead. TODO An image has to be added! Properties: diff --git a/declarativeimports/plasmacomponents/qml/Button.qml b/declarativeimports/plasmacomponents/qml/Button.qml index f21219376..1fdcbba81 100644 --- a/declarativeimports/plasmacomponents/qml/Button.qml +++ b/declarativeimports/plasmacomponents/qml/Button.qml @@ -20,7 +20,7 @@ */ -/**Documentanted API +/**Documented API Inherits: Item diff --git a/declarativeimports/plasmacomponents/qml/ButtonColumn.qml b/declarativeimports/plasmacomponents/qml/ButtonColumn.qml index 775a81cde..2bb6ac461 100644 --- a/declarativeimports/plasmacomponents/qml/ButtonColumn.qml +++ b/declarativeimports/plasmacomponents/qml/ButtonColumn.qml @@ -39,7 +39,7 @@ ** ****************************************************************************/ -/**Documentanted API +/**Documented API Inherits: Column @@ -53,7 +53,6 @@ Description: Note: This component don't support the enabled property. If you need to disable it you should disable all the buttons inside it. - TODO we need an example here... This is an example, diff --git a/declarativeimports/plasmacomponents/qml/ButtonRow.qml b/declarativeimports/plasmacomponents/qml/ButtonRow.qml index 0e51d9f3f..17191e220 100644 --- a/declarativeimports/plasmacomponents/qml/ButtonRow.qml +++ b/declarativeimports/plasmacomponents/qml/ButtonRow.qml @@ -39,7 +39,7 @@ ** ****************************************************************************/ -/**Documentanted API +/**Documented API Inherits: Row @@ -53,7 +53,6 @@ Description: Note: This component don't support the enabled property. If you need to disable it you should disable all the buttons inside it. - TODO we need an example here... This is an example, diff --git a/declarativeimports/plasmacomponents/qml/CheckBox.qml b/declarativeimports/plasmacomponents/qml/CheckBox.qml index 0b204a018..b94f17536 100644 --- a/declarativeimports/plasmacomponents/qml/CheckBox.qml +++ b/declarativeimports/plasmacomponents/qml/CheckBox.qml @@ -17,17 +17,27 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ -/**Documentanted API +/**Documented API Inherits: - DualStateButton + The private DualStateButton Imports: QtQuick 1.0 org.kde.plasma.core Description: - TODO i need more info here + A check box is a component that can be switched on (checked) or off (unchecked). Check boxes are typically used to represent features in an application that can be enabled or disabled without affecting others, but different types of behavior can be implemented. When a check box is checked or unchecked it sends a clicked signal for the application to handle. + When a check box has the focus, its state can be toggled using the Qt.Key_Select, Qt.Key_Return, and Qt.Key_Enter hardware keys that send the clicked signal. Properties: + bool checked: If the button is checked, its checked property is true; otherwise false. The property is false by default. + + bool pressed: If the button is pressed, its pressed property is true. + See also clicked. + + string text: The text is shown beside the check box. By default text is an empty string. +Signals: + clicked(): + Emitted when the user clicked a mouse button over the checkbox (or tapped on the touch screen) **/ import QtQuick 1.0 diff --git a/declarativeimports/plasmacomponents/qml/ContextMenu.qml b/declarativeimports/plasmacomponents/qml/ContextMenu.qml index a660b1350..48e14b48c 100644 --- a/declarativeimports/plasmacomponents/qml/ContextMenu.qml +++ b/declarativeimports/plasmacomponents/qml/ContextMenu.qml @@ -40,6 +40,28 @@ ** ****************************************************************************/ +/**Documented API +Inherits: + Item + +Imports: + QtQuick 1.1 + org.kde.plasma.components + +Description: + Provides a component with list of options that the user can choose from. + +Properties: + * QtObject model + This property holds the model providing data for the menu. + The model provides the set of data that is used to create the items in the view. + Each model item must have a property called "text" or "display". + +Methods: + * void rebuildMenu() + Rebuild the menu if property model is defined. +**/ + import QtQuick 1.1 import org.kde.plasma.components 0.1 diff --git a/declarativeimports/plasmacomponents/qml/Dialog.qml b/declarativeimports/plasmacomponents/qml/Dialog.qml index 1cd66cbba..89dd58651 100644 --- a/declarativeimports/plasmacomponents/qml/Dialog.qml +++ b/declarativeimports/plasmacomponents/qml/Dialog.qml @@ -40,6 +40,56 @@ ** ****************************************************************************/ +/**Documented API +Inherits: + Item + +Imports: + QtQuick 1.0 + org.kde.plasma.core + +Description: + Provides a top-level window for short-term tasks and brief interaction with the user. + A dialog floats on the top layer of the application view, usually overlapping the area reserved for the application content. Normally, a dialog provides information and gives warnings to the user, or asks the user to answer a question or select an option. + +Properties: + list buttons: A list of items in the dialog's button area. For example, you can use Row or Button components but you can also use any number of components that are based on Item component. + + list content: A list of items in the dialog's content area. You can use any component that is based on Item. For example, you can use ListView, so that the user can select from a list of names. + + int status: Indicates the dialog's phase in its life cycle. The values are as follows: + - DialogStatus.Opening - the dialog is opening + - DialogStatus.Open - the dialog is open and visible to the user + - DialogStatus.Closing - the dialog is closing + - DialogStatus.Closed - the dialog is closed and not visible to the user + - The dialog's initial status is DialogStatus.Closed. + + list title: A list of items in the dialog's title area. You can use a Text component but also any number of components that are based on Item. For example, you can use Text and Image components. + + Item visualParent: The item that is dimmed when the dialog opens. By default the root parent object is visualParent. + +Signals: + accepted(): This signal is emitted when the user accepts the dialog's request or the accept() method is called. + See also rejected(). + + clickedOutside(): This signal is emitted when the user taps in the area that is inside the dialog's visual parent area but outside the dialog's area. Normally the visual parent is the root object. In that case this signal is emitted if the user taps anywhere outside the dialog's area. + See also visualParent. + + rejected(): This signal is emitted when the user rejects the dialog's request or the reject() method is called. + See also accepted(). + +Methods: + void accept(): Accepts the dialog's request without any user interaction. The method emits the accepted() signal and closes the dialog. + See also reject(). + + void close(): Closes the dialog without any user interaction. + + void open(): Shows the dialog to the user. + + void reject(): Rejects the dialog's request without any user interaction. The method emits the rejected() signal and closes the dialog. + See also accept(). +**/ + import QtQuick 1.0 import org.kde.plasma.core 0.1 as PlasmaCore import "private/AppManager.js" as Utils diff --git a/declarativeimports/plasmacomponents/qml/Highlight.qml b/declarativeimports/plasmacomponents/qml/Highlight.qml index 4efb0ea82..2d7435c98 100644 --- a/declarativeimports/plasmacomponents/qml/Highlight.qml +++ b/declarativeimports/plasmacomponents/qml/Highlight.qml @@ -17,7 +17,7 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ -/**Documentanted API +/**Documented API Inherits: Item diff --git a/declarativeimports/plasmacomponents/qml/Label.qml b/declarativeimports/plasmacomponents/qml/Label.qml index 90789e196..da44a750f 100644 --- a/declarativeimports/plasmacomponents/qml/Label.qml +++ b/declarativeimports/plasmacomponents/qml/Label.qml @@ -17,16 +17,19 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ -/**Documentanted API +/**Documented API Inherits: - Item + Text Imports: QtQuick 1.0 org.kde.plasma.core Description: - TODO i need more info here + This is a label which uses the plasma theme. + The characteristics of the text will be automatically seted + according to the plasma theme.If you need a more customized + text,then you can use the Text component from QtQuick. **/ import QtQuick 1.0 diff --git a/declarativeimports/plasmacomponents/qml/Page.qml b/declarativeimports/plasmacomponents/qml/Page.qml index 12ca6445c..1bed9461b 100644 --- a/declarativeimports/plasmacomponents/qml/Page.qml +++ b/declarativeimports/plasmacomponents/qml/Page.qml @@ -38,7 +38,7 @@ ** ****************************************************************************/ -/**Documentanted API +/**Documented API Inherits: Item diff --git a/declarativeimports/plasmacomponents/qml/PageStack.qml b/declarativeimports/plasmacomponents/qml/PageStack.qml index 0f742e68b..39ea75b5c 100644 --- a/declarativeimports/plasmacomponents/qml/PageStack.qml +++ b/declarativeimports/plasmacomponents/qml/PageStack.qml @@ -43,7 +43,7 @@ // The PageStack item defines a container for pages and a stack-based // navigation model. Pages can be defined as QML items or components. -/**Documentanted API +/**Documented API Inherits: Item diff --git a/declarativeimports/plasmacomponents/qml/ProgressBar.qml b/declarativeimports/plasmacomponents/qml/ProgressBar.qml index a572206df..4f88cba6f 100644 --- a/declarativeimports/plasmacomponents/qml/ProgressBar.qml +++ b/declarativeimports/plasmacomponents/qml/ProgressBar.qml @@ -17,7 +17,7 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ -/**Documentanted API +/**Documented API Inherits: Item diff --git a/declarativeimports/plasmacomponents/qml/RadioButton.qml b/declarativeimports/plasmacomponents/qml/RadioButton.qml index 1a929fec3..3e269660e 100644 --- a/declarativeimports/plasmacomponents/qml/RadioButton.qml +++ b/declarativeimports/plasmacomponents/qml/RadioButton.qml @@ -17,18 +17,27 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ -/**Documentanted API +/**Documented API Inherits: - DualStateButton + The private DualStateButton Imports: QtQuick 1.0 org.kde.plasma.core Description: - It is a simple Radio button which is using the plasma theme. - TODO Do we need more info? + A radio button component consists of a radio button and a line of text. Only one item in a list may be selected at a time. Once an item is selected, it can be deselected only by selecting another item. Initial item selection may be set at the list creation. If not set, the list is shown without a selection. +Properties: + bool checked: If the button is checked, its checked property is true; otherwise false. The property is false by default. + + bool pressed: If the button is pressed, its pressed property is true. + See also clicked. + + string text: The text is shown beside the check box. By default text is an empty string. +Signals: + clicked(): + Emitted when the user clicked a mouse button over the checkbox (or tapped on the touch screen) **/ import QtQuick 1.0 diff --git a/declarativeimports/plasmacomponents/qml/ScrollBar.qml b/declarativeimports/plasmacomponents/qml/ScrollBar.qml index f68e1fbf5..be37a094c 100644 --- a/declarativeimports/plasmacomponents/qml/ScrollBar.qml +++ b/declarativeimports/plasmacomponents/qml/ScrollBar.qml @@ -18,7 +18,7 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ -/**Documentanted API +/**Documented API Inherits: Item @@ -27,36 +27,57 @@ Imports: QtQuick 1.1 Description: - Just a simple scrollbar which is using the plasma theme. - Plasma theme is the theme which changes via the systemsetting-workspace appearence - -desktop theme. + Just a simple Scroll Bar which is using the plasma theme. + This component does not belongs to the QtComponents API specification + but it was base on ScrollDecorator component. + You should not use it for touch interfaces, use a flickable and a + ScrollDecorator instead. + By default, this component will look and behave like a scroll decorator + on touchscreens Properties: - int orientation: - Sets the orientation. - - bool animated: - TODO + enumeration orientation: + This property holds the orientation where the ScrollBar will scroll. + The orientation can be either Qt.Horizontal or Qt.Vertical + The default value is Qt.Vertical. bool inverted: - Sets if the scrollbar will be inverted or not. + This property holds if the ScrollBar will increase the Flickable + content in the normal direction (Left to Right or Top to Bottom) or + if this will be inverted. + The default value is false. - bool updateValueWhileDragging: true - Sets if the Scrollbar will be resized while it is being dragged. + bool updateValueWhileDragging: + This property holds if the Scrollbar will update the Flickeble + position while dragging or only when released. + The default value is true. - alias stepSize: - Sets the step with which the scrollbar is moving. + real stepSize: + This property holds how many steps exists while moving the handler. + If you want the ScrollBar buttons to appear you must set this property + with a value bigger than 0. + The default value is 0. - alias pressed: - If the scrollbar is pressed it returns true,otherwise false. + bool pressed: + This property holds if the ScrollBar is pressed. - real scrollButtonInterval: 50 + real scrollButtonInterval: + This property holds the interval time used by the ScrollBar button + to increase or decrease steps. - property Flickable flickableItem: null + Flickable flickableItem: + This property holds the Flickable component which the ScrollBar will + interact with. - property bool interactive: - If true,then the scrollbar is interactive otherwise it isn't. + bool interactive: + This property holds if the ScrollBar is interactive. + The default value is true. + + bool enabeld: + This property holds if the button will be enabled for user + interaction. + The default value is true. **/ import QtQuick 1.1 diff --git a/declarativeimports/plasmacomponents/qml/SectionScroller.qml b/declarativeimports/plasmacomponents/qml/SectionScroller.qml index 12bbbcfac..762738738 100644 --- a/declarativeimports/plasmacomponents/qml/SectionScroller.qml +++ b/declarativeimports/plasmacomponents/qml/SectionScroller.qml @@ -37,7 +37,7 @@ ** $QT_END_LICENSE$ ** ****************************************************************************/ -/**Documentanted API +/**Documented API Inherits: Item diff --git a/declarativeimports/plasmacomponents/qml/SelectionDialog.qml b/declarativeimports/plasmacomponents/qml/SelectionDialog.qml index 1f0f8b721..c8d418e78 100644 --- a/declarativeimports/plasmacomponents/qml/SelectionDialog.qml +++ b/declarativeimports/plasmacomponents/qml/SelectionDialog.qml @@ -40,6 +40,34 @@ ** ****************************************************************************/ +/**Documentanted API +Inherits: + CommonDialog + +Imports: + org.kde.plasma.core + QtQuick 1.1 + "." 0.1 + +Description: + This is plasma themed SelectionDialog, with which you can customize the visual representation + of the selectable items' list by overriding the ListView delegate. + By default SelectionDialog provides a scrollable list of textual menu items. + The user can choose one item from the list at a time. + +Properties: + alias model: listView.model: + The model of selectionDialog. + It is just a simple model. + + int selectedIndex: -1 + It returns the index that the user has selected. + The default value is -1. + Component delegate: + This is a common delegate with which,you will choose + how your items will be displayed. +**/ + import QtQuick 1.1 import org.kde.plasma.core 0.1 as PlasmaCore diff --git a/declarativeimports/plasmacomponents/qml/Slider.qml b/declarativeimports/plasmacomponents/qml/Slider.qml index 3c59238a7..447dbb16a 100644 --- a/declarativeimports/plasmacomponents/qml/Slider.qml +++ b/declarativeimports/plasmacomponents/qml/Slider.qml @@ -17,7 +17,7 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ -/**Documentanted API +/**Documented API Inherits: Item diff --git a/declarativeimports/plasmacomponents/qml/Switch.qml b/declarativeimports/plasmacomponents/qml/Switch.qml index 11fec2a89..1a3bf15ee 100644 --- a/declarativeimports/plasmacomponents/qml/Switch.qml +++ b/declarativeimports/plasmacomponents/qml/Switch.qml @@ -17,7 +17,7 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ -/**Documentanted API +/**Documented API Inherits: DualStateButton @@ -26,9 +26,28 @@ Imports: org.kde.plasma.core Description: - TODO + You can bind the Switch component to a feature that the application + has to enable or disable depending on the user's input, for example. + Switch has similar usage and API as CheckBox, except that Switch does + not provide a built-in label. Properties: + bool checked: + Returns true if the Button is checked, otherwise + it returns false. + + alias pressed: + Returns true if the Button is pressed, otherwise + it returns false. + + alias text: + Sets the text for the switch. + The default value is empty.No text + will be displayed. + +Signals: + onClicked: + The signal is emited when the button is clicked! **/ import QtQuick 1.0 import org.kde.plasma.core 0.1 as PlasmaCore diff --git a/declarativeimports/plasmacomponents/qml/TabBar.qml b/declarativeimports/plasmacomponents/qml/TabBar.qml index 07769d895..48ba11834 100644 --- a/declarativeimports/plasmacomponents/qml/TabBar.qml +++ b/declarativeimports/plasmacomponents/qml/TabBar.qml @@ -40,7 +40,7 @@ ** ****************************************************************************/ -/**Documentanted API +/**Documented API Inherits: DualStateButton diff --git a/declarativeimports/plasmacomponents/qml/TabButton.qml b/declarativeimports/plasmacomponents/qml/TabButton.qml index fa99ff6ec..1955dbdcb 100644 --- a/declarativeimports/plasmacomponents/qml/TabButton.qml +++ b/declarativeimports/plasmacomponents/qml/TabButton.qml @@ -40,7 +40,7 @@ ** ****************************************************************************/ -/**Documentanted API +/**Documented API Inherits: Item diff --git a/declarativeimports/plasmacomponents/qml/TabGroup.qml b/declarativeimports/plasmacomponents/qml/TabGroup.qml index 7f60220f7..132ad0f78 100644 --- a/declarativeimports/plasmacomponents/qml/TabGroup.qml +++ b/declarativeimports/plasmacomponents/qml/TabGroup.qml @@ -38,7 +38,7 @@ ** ****************************************************************************/ -/**Documentanted API +/**Documented API Inherits: Item diff --git a/declarativeimports/plasmacomponents/qml/TextArea.qml b/declarativeimports/plasmacomponents/qml/TextArea.qml index b0a07b746..ac2fed69c 100644 --- a/declarativeimports/plasmacomponents/qml/TextArea.qml +++ b/declarativeimports/plasmacomponents/qml/TextArea.qml @@ -17,7 +17,7 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ -/**Documentanted API +/**Documented API Inherits: Item diff --git a/declarativeimports/plasmacomponents/qml/TextField.qml b/declarativeimports/plasmacomponents/qml/TextField.qml index a788a837f..d08cd0c7c 100644 --- a/declarativeimports/plasmacomponents/qml/TextField.qml +++ b/declarativeimports/plasmacomponents/qml/TextField.qml @@ -17,7 +17,7 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ -/**Documentanted API +/**Documented API Inherits: Item diff --git a/declarativeimports/plasmacomponents/qml/ToolBar.qml b/declarativeimports/plasmacomponents/qml/ToolBar.qml index 467396c4e..04dc46320 100644 --- a/declarativeimports/plasmacomponents/qml/ToolBar.qml +++ b/declarativeimports/plasmacomponents/qml/ToolBar.qml @@ -17,7 +17,7 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ -/**Documentanted API +/**Documented API Inherits: PlasmaCore.FrameSvgItem @@ -31,14 +31,25 @@ Description: Properties: Item tools: - The current set of tools; null if none. + The ToolBarLayout that contains the ToolButton components that + are contained in the ToolBar. ToolBarLayout is not mandatory. + The default value is NULL. + string transition: - The transition type. One of the following: + The type of transition to be used for the ToolBar when + the page changes on the relevant PageStack. + The possible values can be one of the following: set an instantaneous change (default) push follows page stack push animation pop follows page stack pop animation replace follows page stack replace animation +Methods: + setTools( tools, transition ) + This sets the tools for the ToolBar and the transition type that + will be used when the page changes on the relevant PageStack. + @arg Item tools see tool property + @arg string transition see transition property **/ import QtQuick 1.1 diff --git a/declarativeimports/plasmacomponents/qml/ToolButton.qml b/declarativeimports/plasmacomponents/qml/ToolButton.qml index f36cf56fd..f18c59f5d 100644 --- a/declarativeimports/plasmacomponents/qml/ToolButton.qml +++ b/declarativeimports/plasmacomponents/qml/ToolButton.qml @@ -18,7 +18,7 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ -/**Documentanted API +/**Documented API Inherits: Item diff --git a/declarativeimports/plasmacomponents/qml/private/ButtonShadow.qml b/declarativeimports/plasmacomponents/qml/private/ButtonShadow.qml index c32b0ade6..bf9e1b731 100644 --- a/declarativeimports/plasmacomponents/qml/private/ButtonShadow.qml +++ b/declarativeimports/plasmacomponents/qml/private/ButtonShadow.qml @@ -18,7 +18,7 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ -/**Documentanted API +/**Documented API Inherits: Item diff --git a/declarativeimports/plasmacomponents/qml/private/DualStateButton.qml b/declarativeimports/plasmacomponents/qml/private/DualStateButton.qml index caa68e61b..1579e8826 100644 --- a/declarativeimports/plasmacomponents/qml/private/DualStateButton.qml +++ b/declarativeimports/plasmacomponents/qml/private/DualStateButton.qml @@ -17,7 +17,7 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ -/**Documentanted API +/**Documented API Inherits: Item diff --git a/declarativeimports/plasmacomponents/qml/private/IconLoader.qml b/declarativeimports/plasmacomponents/qml/private/IconLoader.qml index 186de9460..0b2c03e79 100644 --- a/declarativeimports/plasmacomponents/qml/private/IconLoader.qml +++ b/declarativeimports/plasmacomponents/qml/private/IconLoader.qml @@ -17,7 +17,7 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ -/**Documentanted API +/**Documented API Inherits: Item diff --git a/declarativeimports/plasmacomponents/qml/private/RoundShadow.qml b/declarativeimports/plasmacomponents/qml/private/RoundShadow.qml index 07343dc4d..b94cc6bf1 100644 --- a/declarativeimports/plasmacomponents/qml/private/RoundShadow.qml +++ b/declarativeimports/plasmacomponents/qml/private/RoundShadow.qml @@ -18,7 +18,7 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ -/**Documentanted API +/**Documented API Inherits: Item diff --git a/declarativeimports/plasmacomponents/qml/private/TabBarLayout.qml b/declarativeimports/plasmacomponents/qml/private/TabBarLayout.qml index f3aa2951f..f22bfdc7d 100644 --- a/declarativeimports/plasmacomponents/qml/private/TabBarLayout.qml +++ b/declarativeimports/plasmacomponents/qml/private/TabBarLayout.qml @@ -40,7 +40,7 @@ ** ****************************************************************************/ -/**Documentanted API +/**Documented API Inherits: Item