Made wxAny::IsNull() doc string a bit clearer

[wxWidgets.git] / include / wx / control.h

diff --git a/include/wx/control.h b/include/wx/control.h
index f947f0f203cf86b78b9c9aaea3c04dd7d7381344..79d6d833fd080034ddad3a5ac43890d65c6130df 100644 (file)
--- a/include/wx/control.h
+++ b/include/wx/control.h
@@ -39,8 +39,11 @@ enum wxEllipsizeFlags
                                 wxELLIPSIZE_FLAGS_EXPAND_TABS
 };
 
                                 wxELLIPSIZE_FLAGS_EXPAND_TABS
 };
 

+// NB: Don't change the order of these values, they're the same as in
+//     PangoEllipsizeMode enum.

 enum wxEllipsizeMode
 {
 enum wxEllipsizeMode
 {

+    wxELLIPSIZE_NONE,

     wxELLIPSIZE_START,
     wxELLIPSIZE_MIDDLE,
     wxELLIPSIZE_END
     wxELLIPSIZE_START,
     wxELLIPSIZE_MIDDLE,
     wxELLIPSIZE_END


@@ -68,6 +71,7 @@ public:
     // get the control alignment (left/right/centre, top/bottom/centre)
     int GetAlignment() const { return m_windowStyle & wxALIGN_MASK; }
 
     // get the control alignment (left/right/centre, top/bottom/centre)
     int GetAlignment() const { return m_windowStyle & wxALIGN_MASK; }
 

+    // set label with mnemonics

     virtual void SetLabel(const wxString& label)
     {
         m_labelOrig = label;
     virtual void SetLabel(const wxString& label)
     {
         m_labelOrig = label;


@@ -77,21 +81,19 @@ public:
         wxWindow::SetLabel(label);
     }
 
         wxWindow::SetLabel(label);
     }
 

-    virtual wxString GetLabel() const
-    {
-        // return the original string, as it was passed to SetLabel()
-        // (i.e. with wx-style mnemonics)
-        return m_labelOrig;
-    }
-
-    // get just the text of the label, without mnemonic characters ('&')
-    wxString GetLabelText() const { return GetLabelText(GetLabel()); }
+    // return the original string, as it was passed to SetLabel()
+    // (i.e. with wx-style mnemonics)
+    virtual wxString GetLabel() const { return m_labelOrig; }

 
 

-    void SetLabelText(const wxString& text)
+    // set label text (mnemonics will be escaped)
+    virtual void SetLabelText(const wxString& text)

     {
         SetLabel(EscapeMnemonics(text));
     }
 
     {
         SetLabel(EscapeMnemonics(text));
     }
 

+    // get just the text of the label, without mnemonic characters ('&')
+    virtual wxString GetLabelText() const { return GetLabelText(GetLabel()); }
+

     // controls by default inherit the colours of their parents, if a
     // particular control class doesn't want to do it, it can override
     // ShouldInheritColours() to return false
     // controls by default inherit the colours of their parents, if a
     // particular control class doesn't want to do it, it can override
     // ShouldInheritColours() to return false


@@ -111,23 +113,29 @@ public:
 
 
 
 
 
 

-    // static utilities
-    // ----------------
-
-    // replaces parts of the (multiline) string with ellipsis if needed
-    static wxString Ellipsize(const wxString& label, const wxDC& dc,
-                              wxEllipsizeMode mode, int maxWidth,
-                              int flags = wxELLIPSIZE_FLAGS_DEFAULT);
+    // static utilities for mnemonics char (&) handling
+    // ------------------------------------------------

 
 

-    // get the string without mnemonic characters ('&')
+    // returns the given string without mnemonic characters ('&')

     static wxString GetLabelText(const wxString& label);
 
     static wxString GetLabelText(const wxString& label);
 

-    // removes the mnemonics characters
+    // returns the given string without mnemonic characters ('&')
+    // this function is identic to GetLabelText() and is provided for clarity
+    // and for symmetry with the wxStaticText::RemoveMarkup() function.

     static wxString RemoveMnemonics(const wxString& str);
 
     // escapes (by doubling them) the mnemonics
     static wxString EscapeMnemonics(const wxString& str);
 
     static wxString RemoveMnemonics(const wxString& str);
 
     // escapes (by doubling them) the mnemonics
     static wxString EscapeMnemonics(const wxString& str);
 

+
+    // miscellaneous static utilities
+    // ------------------------------
+
+    // replaces parts of the given (multiline) string with an ellipsis if needed
+    static wxString Ellipsize(const wxString& label, const wxDC& dc,
+                              wxEllipsizeMode mode, int maxWidth,
+                              int flags = wxELLIPSIZE_FLAGS_DEFAULT);
+

     // return the accel index in the string or -1 if none and puts the modified
     // string into second parameter if non NULL
     static int FindAccelIndex(const wxString& label,
     // return the accel index in the string or -1 if none and puts the modified
     // string into second parameter if non NULL
     static int FindAccelIndex(const wxString& label,


@@ -162,7 +170,8 @@ protected:
                                           wxEllipsizeMode mode, int maxWidth,
                                           int replacementWidth, int marginWidth);
 
                                           wxEllipsizeMode mode, int maxWidth,
                                           int replacementWidth, int marginWidth);
 

-    // this field contains the label in wx format, i.e. with '&' mnemonics
+    // this field contains the label in wx format, i.e. with '&' mnemonics,
+    // as it was passed to the last SetLabel() call

     wxString m_labelOrig;
 
     wxDECLARE_NO_COPY_CLASS(wxControlBase);
     wxString m_labelOrig;
 
     wxDECLARE_NO_COPY_CLASS(wxControlBase);