Doxygenize ListItem
This commit is contained in:
parent
ce2459b4ba
commit
cd453af5a8
@ -17,55 +17,57 @@
|
||||
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
||||
*/
|
||||
|
||||
/**Documented API
|
||||
Inherits:
|
||||
Item
|
||||
|
||||
Imports:
|
||||
org.kde.plasma.core
|
||||
QtQuick 1.0
|
||||
|
||||
Description:
|
||||
An item delegate for the primitive ListView component. It's intended to make all listview look coherent
|
||||
|
||||
Properties:
|
||||
* bool checked:
|
||||
If true makes the list item look as checked or pressed. It has to be set from the code, it won't change by itself.
|
||||
|
||||
* bool sectionDelegate:
|
||||
If true the item will be a delegate for a section, so will look like a "title" for the otems under it.
|
||||
|
||||
* bool enabled:
|
||||
Holds if the item emits signals related to mouse interaction.
|
||||
The default value is false.
|
||||
|
||||
Signals:
|
||||
* clicked():
|
||||
This handler is called when there is a click.
|
||||
This is disabled by default, use enable property to activate it.
|
||||
|
||||
* pressAndHold():
|
||||
The user pressed the item with the mouse and didn't release it for a certain amount of time.
|
||||
This is disabled by default, use enable property to activate it.
|
||||
**/
|
||||
|
||||
import QtQuick 1.0
|
||||
import org.kde.plasma.core 0.1 as PlasmaCore
|
||||
import "private/Config.js" as Config
|
||||
|
||||
/**
|
||||
* An item delegate for the primitive ListView component.
|
||||
*
|
||||
* It's intended to make all listviews look coherent.
|
||||
*/
|
||||
Item {
|
||||
id: listItem
|
||||
default property alias content: paddingItem.data
|
||||
|
||||
//this defines if the item will emit clicked and look pressed on mouse down
|
||||
/**
|
||||
* type:bool Holds if the item emits signals related to mouse interaction.
|
||||
*
|
||||
* The default value is false.
|
||||
*/
|
||||
property alias enabled: itemMouse.enabled
|
||||
//item has been clicked or pressed+hold
|
||||
|
||||
/**
|
||||
* This signal is emitted when there is a click.
|
||||
*
|
||||
* This is disabled by default, set enabled to true to use it.
|
||||
* @see enabled
|
||||
*/
|
||||
signal clicked
|
||||
|
||||
|
||||
/**
|
||||
* The user pressed the item with the mouse and didn't release it for a
|
||||
* certain amount of time.
|
||||
*
|
||||
* This is disabled by default, set enabled to true to use it.
|
||||
* @see enabled
|
||||
*/
|
||||
signal pressAndHold
|
||||
|
||||
/**
|
||||
* If true makes the list item look as checked or pressed. It has to be set
|
||||
* from the code, it won't change by itself.
|
||||
*/
|
||||
//plasma extension
|
||||
//always look pressed?
|
||||
property bool checked: false
|
||||
|
||||
/**
|
||||
* If true the item will be a delegate for a section, so will look like a
|
||||
* "title" for the otems under it.
|
||||
*/
|
||||
//is this to be used as section delegate?
|
||||
property bool sectionDelegate: false
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user