Documentation for properties without change signal

This commit is contained in:
Martin Gräßlin 2011-12-22 18:16:04 +01:00
parent 20284fb7bb
commit da26ecb8ef

View file

@ -117,13 +117,28 @@ class Client
* Whether the Client represents a modal window. * Whether the Client represents a modal window.
**/ **/
Q_PROPERTY(bool modal READ isModal NOTIFY modalChanged) Q_PROPERTY(bool modal READ isModal NOTIFY modalChanged)
/**
* Whether the Client is moveable. Even if it is not moveable, it might be possible to move
* it to another screen. The property is evaluated each time it is invoked.
* Because of that there is no notify signal.
* @see moveableAcrossScreens
**/
Q_PROPERTY(bool moveable READ isMovable) Q_PROPERTY(bool moveable READ isMovable)
/**
* Whether the Client can be moved to another screen. The property is evaluated each time it is invoked.
* Because of that there is no notify signal.
* @see moveable
**/
Q_PROPERTY(bool moveableAcrossScreens READ isMovableAcrossScreens) Q_PROPERTY(bool moveableAcrossScreens READ isMovableAcrossScreens)
/** /**
* Whether the Client provides context help. Mostly needed by decorations to decide whether to * Whether the Client provides context help. Mostly needed by decorations to decide whether to
* show the help button or not. * show the help button or not.
**/ **/
Q_PROPERTY(bool providesContextHelp READ providesContextHelp CONSTANT) Q_PROPERTY(bool providesContextHelp READ providesContextHelp CONSTANT)
/**
* Whether the Client can be resized. The property is evaluated each time it is invoked.
* Because of that there is no notify signal.
**/
Q_PROPERTY(bool resizeable READ isResizable) Q_PROPERTY(bool resizeable READ isResizable)
/** /**
* Whether the Client can be shaded. The property is evaluated each time it is invoked. * Whether the Client can be shaded. The property is evaluated each time it is invoked.