document all currently defined image options and their values

[wxWidgets.git] / interface / wx / propgrid / propgrid.h

diff --git a/interface/wx/propgrid/propgrid.h b/interface/wx/propgrid/propgrid.h
index 202dd9c71762e0536994146c765a0daba9bc7560..de580e638431f9bf0ad61c642f80a2cd2815950e 100644 (file)
--- a/interface/wx/propgrid/propgrid.h
+++ b/interface/wx/propgrid/propgrid.h
@@ -32,7 +32,7 @@ wxPG_AUTO_SORT                      = 0x00000010,
 */
 wxPG_HIDE_CATEGORIES                = 0x00000020,
 
 */
 wxPG_HIDE_CATEGORIES                = 0x00000020,
 

-/*
+/**

     This style combines non-categoric mode and automatic sorting.
 */
 wxPG_ALPHABETIC_MODE                = (wxPG_HIDE_CATEGORIES|wxPG_AUTO_SORT),
     This style combines non-categoric mode and automatic sorting.
 */
 wxPG_ALPHABETIC_MODE                = (wxPG_HIDE_CATEGORIES|wxPG_AUTO_SORT),


@@ -213,15 +213,14 @@ typedef wxByte wxPGVFBFlags;
     wxPGValidationInfo
 
     Used to convey validation information to and from functions that
     wxPGValidationInfo
 
     Used to convey validation information to and from functions that

-    actually perform validation. Mostly used in custom property
-    classes.
+    actually perform validation. Mostly used in custom property classes.

 */
 class wxPGValidationInfo
 {
 public:
     /**
         @return Returns failure behavior which is a combination of
 */
 class wxPGValidationInfo
 {
 public:
     /**
         @return Returns failure behavior which is a combination of

-               @ref propgrid_vfbflags.
+            @ref propgrid_vfbflags.

     */
     wxPGVFBFlags GetFailureBehavior();
 
     */
     wxPGVFBFlags GetFailureBehavior();
 


@@ -252,6 +251,7 @@ public:
 
 /**
     @section propgrid_keyboard_actions wxPropertyGrid Action Identifiers
 
 /**
     @section propgrid_keyboard_actions wxPropertyGrid Action Identifiers

+

     These are used with wxPropertyGrid::AddActionTrigger() and
     wxPropertyGrid::ClearActionTriggers().
     @{
     These are used with wxPropertyGrid::AddActionTrigger() and
     wxPropertyGrid::ClearActionTriggers().
     @{


@@ -273,9 +273,10 @@ enum wxPG_KEYBOARD_ACTIONS
 
 // -----------------------------------------------------------------------
 
 
 // -----------------------------------------------------------------------
 

-/** @class wxPropertyGrid
+/**
+    @class wxPropertyGrid

 
 

-      wxPropertyGrid is a specialized grid for editing properties - in other
+    wxPropertyGrid is a specialized grid for editing properties - in other

     words name = value pairs. List of ready-to-use property classes include
     strings, numbers, flag sets, fonts, colours and many others. It is possible,
     for example, to categorize properties, set up a complete tree-hierarchy,
     words name = value pairs. List of ready-to-use property classes include
     strings, numbers, flag sets, fonts, colours and many others. It is possible,
     for example, to categorize properties, set up a complete tree-hierarchy,


@@ -324,37 +325,34 @@ enum wxPG_KEYBOARD_ACTIONS
     @endEventTable
 
     @remarks
     @endEventTable
 
     @remarks

-
-    - Use Freeze() and Thaw() respectively to disable and enable drawing. This
-      will also delay sorting etc. miscellaneous calculations to the last
-      possible moment.
+    Use Freeze() and Thaw() respectively to disable and enable drawing.
+    This will also delay sorting etc. miscellaneous calculations to the last
+    possible moment.

 
     @library{wxpropgrid}
     @category{propgrid}
     @appearance{propertygrid.png}
 
     @library{wxpropgrid}
     @category{propgrid}
     @appearance{propertygrid.png}

-    

 */
 class wxPropertyGrid : public wxScrolledWindow, public wxPropertyGridInterface
 {
 public:
 */
 class wxPropertyGrid : public wxScrolledWindow, public wxPropertyGridInterface
 {
 public:

-
-       /**
-        Two step constructor. Call Create when this constructor is called to
-        build up the wxPropertyGrid
-       */
+    /**
+        Two step constructor.
+        Call Create() when this constructor is called to build up the wxPropertyGrid
+    */

     wxPropertyGrid();
 
     /**
     wxPropertyGrid();
 
     /**

-        Constructor. The styles to be used are styles valid for
-        the wxWindow and wxScrolledWindow.
+        Constructor.
+        The styles to be used are styles valid for the wxWindow and wxScrolledWindow.

 
         @see @ref propgrid_window_styles.
     */
     wxPropertyGrid( wxWindow *parent, wxWindowID id = wxID_ANY,
 
         @see @ref propgrid_window_styles.
     */
     wxPropertyGrid( wxWindow *parent, wxWindowID id = wxID_ANY,

-                           const wxPoint& pos = wxDefaultPosition,
-                           const wxSize& size = wxDefaultSize,
-                           long style = wxPG_DEFAULT_STYLE,
-                           const wxChar* name = wxPropertyGridNameStr );
+                    const wxPoint& pos = wxDefaultPosition,
+                    const wxSize& size = wxDefaultSize,
+                    long style = wxPG_DEFAULT_STYLE,
+                    const wxChar* name = wxPropertyGridNameStr );

 
     /** Destructor */
     virtual ~wxPropertyGrid();
 
     /** Destructor */
     virtual ~wxPropertyGrid();


@@ -364,10 +362,8 @@ public:
 
         @param action
             Which action to trigger. See @ref propgrid_keyboard_actions.
 
         @param action
             Which action to trigger. See @ref propgrid_keyboard_actions.

-

         @param keycode
             Which keycode triggers the action.
         @param keycode
             Which keycode triggers the action.

-

         @param modifiers
             Which key event modifiers, in addition to keycode, are needed to
             trigger the action.
         @param modifiers
             Which key event modifiers, in addition to keycode, are needed to
             trigger the action.


@@ -429,10 +425,10 @@ public:
         @see @ref propgrid_window_styles.
     */
     bool Create( wxWindow *parent, wxWindowID id = wxID_ANY,
         @see @ref propgrid_window_styles.
     */
     bool Create( wxWindow *parent, wxWindowID id = wxID_ANY,

-                 const wxPoint& pos = wxDefaultPosition,
-                 const wxSize& size = wxDefaultSize,
-                 long style = wxPG_DEFAULT_STYLE,
-                 const wxChar* name = wxPropertyGridNameStr );
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = wxPG_DEFAULT_STYLE,
+                const wxChar* name = wxPropertyGridNameStr );

 
     /**
         Call when editor widget's contents is modified. For example, this is
 
     /**
         Call when editor widget's contents is modified. For example, this is


@@ -443,21 +439,22 @@ public:
 
         @see wxPGProperty::OnEvent()
     */
 
         @see wxPGProperty::OnEvent()
     */

-    void EditorsValueWasModified() { m_iFlags |= wxPG_FL_VALUE_MODIFIED; }
+    void EditorsValueWasModified();

 
     /**
         Reverse of EditorsValueWasModified().
 
         @remarks This function should only be called by custom properties.
     */
 
     /**
         Reverse of EditorsValueWasModified().
 
         @remarks This function should only be called by custom properties.
     */

-    void EditorsValueWasNotModified()
-    {
-        m_iFlags &= ~(wxPG_FL_VALUE_MODIFIED);
-    }
+    void EditorsValueWasNotModified();

 
     /**
         Enables or disables (shows/hides) categories according to parameter
         enable.
 
     /**
         Enables or disables (shows/hides) categories according to parameter
         enable.

+
+        @remarks This functions deselects selected property, if any. Validation
+                failure option wxPG_VFB_STAY_IN_PROPERTY is not respected, ie.
+                selection is cleared even if editor had invalid value.

     */
     bool EnableCategories( bool enable );
 
     */
     bool EnableCategories( bool enable );
 


@@ -593,16 +590,6 @@ public:
     */
     wxVariant GetUncommittedPropertyValue();
 
     */
     wxVariant GetUncommittedPropertyValue();
 

-    /**
-        Returns cell background colour of a property.
-    */
-    wxColour GetPropertyBackgroundColour( wxPGPropArg id ) const;
-
-    /**
-        Returns cell background colour of a property.
-    */
-    wxColour GetPropertyTextColour( wxPGPropArg id ) const;
-

     /**
         Returns "root property". It does not have name, etc. and it is not
         visible. It is only useful for accessing its children.
     /**
         Returns "root property". It does not have name, etc. and it is not
         visible. It is only useful for accessing its children.


@@ -648,7 +635,7 @@ public:
     /**
         Returns current vertical spacing.
     */
     /**
         Returns current vertical spacing.
     */

-    int GetVerticalSpacing() const { return (int)m_vspacing; }
+    int GetVerticalSpacing() const;

 
     /**
         Returns true if editor's value was marked modified.
 
     /**
         Returns true if editor's value was marked modified.


@@ -677,8 +664,8 @@ public:
 
         @code
             control->Connect(control->GetId(), wxEVT_COMMAND_TEXT_UPDATED,
 
         @code
             control->Connect(control->GetId(), wxEVT_COMMAND_TEXT_UPDATED,

-                             wxEventHandler(wxPropertyGrid::OnCustomEditorEvent),
-                             NULL, propgrid);
+                            wxEventHandler(wxPropertyGrid::OnCustomEditorEvent),
+                            NULL, propgrid);

         @endcode
 
         @remarks You should never need to call this function directly!
         @endcode
 
         @remarks You should never need to call this function directly!


@@ -786,32 +773,18 @@ public:
     void SetMarginColour(const wxColour& col);
 
     /**
     void SetMarginColour(const wxColour& col);
 
     /**

-        Sets background colour of property and all its children. Colours of
-        captions are not affected. Background brush cache is optimized for often
-        set colours to be set last.
+        Sets selection background colour - applies to selected property name
+        background.

     */
     */

-    void SetPropertyBackgroundColour( wxPGPropArg id, const wxColour& col );
-
-    /**
-        Resets text and background colours of given property.
-    */
-    void SetPropertyColoursToDefault( wxPGPropArg id );
+    void SetSelectionBackgroundColour(const wxColour& col);

 
     /**
 
     /**

-        Sets text colour of property and all its children.
+        Sets selection foreground colour - applies to selected property name text.

     */
     */

-    void SetPropertyTextColour( wxPGPropArg id, const wxColour& col,
-                                bool recursively = true );
-
-    /** Sets selection background colour - applies to selected property name
-        background. */
-    void SetSelectionBackgroundColour(const wxColour& col);
-
-    /** Sets selection foreground colour - applies to selected property name
-        text. */

     void SetSelectionTextColour(const wxColour& col);
 
     void SetSelectionTextColour(const wxColour& col);
 

-    /** Sets x coordinate of the splitter.
+    /**
+        Sets x coordinate of the splitter.

 
         @remarks Splitter position cannot exceed grid size, and therefore setting
                 it during form creation may fail as initial grid size is often
 
         @remarks Splitter position cannot exceed grid size, and therefore setting
                 it during form creation may fail as initial grid size is often


@@ -827,10 +800,7 @@ public:
         @param privateChildrenToo
             If @false, will still allow private children to be cropped.
     */
         @param privateChildrenToo
             If @false, will still allow private children to be cropped.
     */

-    void SetSplitterLeft( bool privateChildrenToo = false )
-    {
-        m_pState->SetSplitterLeft(subProps);
-    }
+    void SetSplitterLeft( bool privateChildrenToo = false );

 
     /**
         Sets vertical spacing. Can be 1, 2, or 3 - a value relative to font
 
     /**
         Sets vertical spacing. Can be 1, 2, or 3 - a value relative to font


@@ -845,11 +815,19 @@ public:
 
     /**
         Sorts all items at all levels (except private children).
 
     /**
         Sorts all items at all levels (except private children).

+
+        @remarks This functions deselects selected property, if any. Validation
+                failure option wxPG_VFB_STAY_IN_PROPERTY is not respected, ie.
+                selection is cleared even if editor had invalid value.

     */
     void Sort();
 
     /**
         Sorts children of a property.
     */
     void Sort();
 
     /**
         Sorts children of a property.

+
+        @remarks This functions deselects selected property, if any. Validation
+                failure option wxPG_VFB_STAY_IN_PROPERTY is not respected, ie.
+                selection is cleared even if editor had invalid value.

     */
     void SortChildren( wxPGPropArg id );
 };
     */
     void SortChildren( wxPGPropArg id );
 };


@@ -880,7 +858,7 @@ public:
     /**
         Returns true if you can veto the action that the event is signaling.
     */
     /**
         Returns true if you can veto the action that the event is signaling.
     */

-    bool CanVeto() const { return m_canVeto; }
+    bool CanVeto() const;

 
     /** Copyer. */
     virtual wxEvent* Clone() const;
 
     /** Copyer. */
     virtual wxEvent* Clone() const;


@@ -914,7 +892,7 @@ public:
         Set if event can be vetoed.
     */
     void SetCanVeto( bool canVeto );
         Set if event can be vetoed.
     */
     void SetCanVeto( bool canVeto );

-    
+

     /** Changes the property associated with this event. */
     void SetProperty( wxPGProperty* p );
 
     /** Changes the property associated with this event. */
     void SetProperty( wxPGProperty* p );