Added wxPGChoices::Copy(), tweaked related documentation

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

diff --git a/include/wx/control.h b/include/wx/control.h
index ce8aabe406014541454d3240db34e608164e61b4..e2db727b4c95da3f0ee9bae52aa19274d5c182db 100644 (file)
--- a/include/wx/control.h
+++ b/include/wx/control.h
@@ -22,13 +22,20 @@
 
 #include "wx/window.h"      // base class
 
 
 #include "wx/window.h"      // base class
 

-extern WXDLLEXPORT_DATA(const wxChar) wxControlNameStr[];
+extern WXDLLIMPEXP_DATA_CORE(const char) wxControlNameStr[];
+
+enum wxEllipsizeMode
+{
+    wxELLIPSIZE_START,
+    wxELLIPSIZE_MIDDLE,
+    wxELLIPSIZE_END
+};

 
 // ----------------------------------------------------------------------------
 // wxControl is the base class for all controls
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // wxControl is the base class for all controls
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxControlBase : public wxWindow
+class WXDLLIMPEXP_CORE wxControlBase : public wxWindow

 {
 public:
     wxControlBase() { }
 {
 public:
     wxControlBase() { }


@@ -46,6 +53,50 @@ 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; }
 

+    virtual void SetLabel(const wxString& label)
+    {
+        m_labelOrig = label;
+
+        InvalidateBestSize();
+
+        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()); }
+
+    void SetLabelText(const wxString& text)
+    {
+        SetLabel(EscapeMnemonics(text));
+    }
+
+    // static utilities:
+
+    // replaces parts of the string with ellipsis if needed
+    static wxString Ellipsize(const wxString& label, const wxDC& dc,
+                              wxEllipsizeMode mode, int maxWidth);
+
+    // get the string without mnemonic characters ('&')
+    static wxString GetLabelText(const wxString& label);
+
+    // removes the mnemonics characters
+    static wxString RemoveMnemonics(const wxString& str);
+
+    // escapes (by doubling them) the mnemonics
+    static wxString EscapeMnemonics(const wxString& str);
+
+    // 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,
+                              wxString *labelOnly = NULL);
+

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


@@ -59,21 +110,15 @@ public:
     // if the button was clicked)
     virtual void Command(wxCommandEvent &event);
 
     // if the button was clicked)
     virtual void Command(wxCommandEvent &event);
 

-    virtual void SetLabel( const wxString &label );

     virtual bool SetFont(const wxFont& font);
 
     virtual bool SetFont(const wxFont& font);
 

-    // Reserved for future use
-    virtual void ReservedControlFunc1() {}
-    virtual void ReservedControlFunc2() {}
-    virtual void ReservedControlFunc3() {}
-    virtual void ReservedControlFunc4() {}
-    virtual void ReservedControlFunc5() {}
-    virtual void ReservedControlFunc6() {}
-    virtual void ReservedControlFunc7() {}
-    virtual void ReservedControlFunc8() {}
-    virtual void ReservedControlFunc9() {}
+    // wxControl-specific processing after processing the update event
+    virtual void DoUpdateWindowUI(wxUpdateUIEvent& event);

 
 protected:
 
 protected:

+    // choose the default border for this window
+    virtual wxBorder GetDefaultBorder() const;
+

     // creates the control (calls wxWindowBase::CreateBase inside) and adds it
     // to the list of parents children
     bool CreateControl(wxWindowBase *parent,
     // creates the control (calls wxWindowBase::CreateBase inside) and adds it
     // to the list of parents children
     bool CreateControl(wxWindowBase *parent,


@@ -87,16 +132,8 @@ protected:
     // initialize the common fields of wxCommandEvent
     void InitCommandEvent(wxCommandEvent& event) const;
 
     // initialize the common fields of wxCommandEvent
     void InitCommandEvent(wxCommandEvent& event) const;
 

-    // set the initial window size if none is given (i.e. at least one of the
-    // components of the size passed to ctor/Create() is -1)
-    //
-    // normally just calls SetBestSize() but can be overridden not to do it for
-    // the controls which have to do some additional initialization (e.g. add
-    // strings to list box) before their best size can be accurately calculated
-    virtual void SetInitialBestSize(const wxSize& size)
-    {
-        SetBestSize(size);
-    }
+    // this field contains the label in wx format, i.e. with '&' mnemonics
+    wxString m_labelOrig;

 
     DECLARE_NO_COPY_CLASS(wxControlBase)
 };
 
     DECLARE_NO_COPY_CLASS(wxControlBase)
 };


@@ -113,10 +150,12 @@ protected:
     #include "wx/msw/control.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/control.h"
     #include "wx/msw/control.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/control.h"

-#elif defined(__WXGTK__)
+#elif defined(__WXGTK20__)

     #include "wx/gtk/control.h"
     #include "wx/gtk/control.h"

+#elif defined(__WXGTK__)
+    #include "wx/gtk1/control.h"

 #elif defined(__WXMAC__)
 #elif defined(__WXMAC__)

-    #include "wx/mac/control.h"
+    #include "wx/osx/control.h"

 #elif defined(__WXCOCOA__)
     #include "wx/cocoa/control.h"
 #elif defined(__WXPM__)
 #elif defined(__WXCOCOA__)
     #include "wx/cocoa/control.h"
 #elif defined(__WXPM__)