Commit 00d41156 authored by Boudewijn Rempt's avatar Boudewijn Rempt

Spread the apidox goodness a bit further.

parent 4eb2ffee
......@@ -26,7 +26,10 @@
/**
* This is a special base class for all the options that load/save
* settings into a properties objects and do *not* store the properties
* themselves. This class adapts your option to allow its easy use with
* themselves. A KisPaintOpOption derived class generates a QWidget for
* its configuration page. This cannot be created from a KisPaintO[
*
* This class adapts your option to allow its easy use with
* both raw pointers and shared pointers.
*
* Motivation:
......
......@@ -37,6 +37,11 @@ class KisPaintopLodLimitations;
* (for example, a curve), a user-visible name and can
* be serialized and deserialized into KisPaintOpPresets
*
* Because KisPaintOpOption classes create a QWidget in
* their constructor (the configuration page) you CANNOT
* create those objects in a KisPaintOp. KisPaintOps are
* created in non-gui threads.
*
* Options are disabled by default.
*/
class KRITAUI_EXPORT KisPaintOpOption : public QObject
......
......@@ -40,7 +40,7 @@ The following classes are important:
<li>Classes derived from KisPaintOpOption. These classes create a configuration
widget. That means that you cannot construct any those objects in a
KisPaintOp. KisPaintOps are created in non-gui threads.
<li>Classes derived from KisCurveOption.KisCurveOption classes have a generic GUI widget,
<li>Classes derived from KisCurveOption. KisCurveOption classes have a generic GUI widget,
KisCurveOptionWidget. So, in contrast to KisPaintOpOption classes, KisCurveOption
instances can and will be created in the constructor of KisPaintOp paintops.
This class can manage to read and write its settings directly.
......
......@@ -39,6 +39,11 @@ class KisDynamicSensor;
*
* Note: it is NOT a KisPaintOpOption, even though the API is pretty similar!
*
* KisCurveOption classes have a generic GUI widget, KisCurveOptionWidget. So,
* in contrast to KisPaintOpOption classes, KisCurveOption instances can and
* will be created in the constructor of KisPaintOp paintops. This class can
* manage to read and write its settings directly.
*
*/
class PAINTOP_EXPORT KisCurveOption
{
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment