[Libreoffice-commits] core.git: include/svl

[Ursache Vladimir]

 include/svl/poolitem.hxx |   29 ++++++++++++++++++++++++++---
 1 file changed, 26 insertions(+), 3 deletions(-)

New commits:
commit 031166e43ff2e476df5158ff3e6e631b0c346441
Author: Ursache Vladimir <ursache at collabora.co.uk>
Date:   Sun Feb 15 05:13:58 2015 +0200

    Document SfxItemState
    
    Change-Id: I7cb0b7977b221438e4359c5c96c174f7401f9857
    Reviewed-on: https://gerrit.libreoffice.org/14496
    Tested-by: Jenkins <ci at libreoffice.org>
    Reviewed-by: Noel Grandin <noelgrandin at gmail.com>

diff --git a/include/svl/poolitem.hxx b/include/svl/poolitem.hxx
index 93f6bf9..182da19 100644
--- a/include/svl/poolitem.hxx
+++ b/include/svl/poolitem.hxx
@@ -119,15 +119,38 @@ enum SfxItemPresentation
     SFX_ITEM_PRESENTATION_COMPLETE
 };
 
-
-
+/**
+ * These values have to match the values in the
+ * com::sun::star::frame::status::ItemState IDL
+ * to be found at offapi/com/sun/star/frame/status/ItemState.idl
+*/
 enum class SfxItemState {
-    // These values have to match the values in the com::sun::star::frame::status::ItemState IDL
+
+    /** Specifies an unknown state. */
     UNKNOWN  = 0,
+
+    /** Specifies that the property is currently disabled. */
     DISABLED = 0x0001,
+
+    /** Specifies that the property is currently read-only. */
     READONLY = 0x0002,
+
+    /** Specifies that the property is currently in a don't care state.
+     * <br/>
+     * This is normally used if a selection provides more than one state
+     * for a property at the same time.
+     */
     DONTCARE = 0x0010,
+
+    /** Specifies that the property is currently in a default state. */
     DEFAULT  = 0x0020,
+
+    /** The property has been explicitly set to a given value hence we know
+     * we are not taking the default value.
+     * <br/>
+     * For example, you may want to get the font color and it might either
+     * be the default one or one that has been explicitly set.
+    */
     SET      = 0x0030
 };