Use wxWebKitCtrlNameStr to adhere to the convention used by other wx classes.

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

diff --git a/include/wx/control.h b/include/wx/control.h
index 3d745c679ef9bd33ca12084c15bfbb11c050730e..8f1a1767c140da61fad3ed57e3af44738bba6a51 100644 (file)
--- a/include/wx/control.h
+++ b/include/wx/control.h
@@ -24,8 +24,26 @@
 
 extern WXDLLIMPEXP_DATA_CORE(const char) wxControlNameStr[];
 
+
+// ----------------------------------------------------------------------------
+// Ellipsize() constants
+// ----------------------------------------------------------------------------
+
+enum wxEllipsizeFlags
+{
+    wxELLIPSIZE_FLAGS_NONE = 0,
+    wxELLIPSIZE_FLAGS_PROCESS_MNEMONICS = 1,
+    wxELLIPSIZE_FLAGS_EXPAND_TABS = 2,
+
+    wxELLIPSIZE_FLAGS_DEFAULT = wxELLIPSIZE_FLAGS_PROCESS_MNEMONICS |
+                                wxELLIPSIZE_FLAGS_EXPAND_TABS
+};
+
+// NB: Don't change the order of these values, they're the same as in
+//     PangoEllipsizeMode enum.
 enum wxEllipsizeMode
 {
+    wxELLIPSIZE_NONE,
     wxELLIPSIZE_START,
     wxELLIPSIZE_MIDDLE,
     wxELLIPSIZE_END
@@ -74,14 +92,35 @@ public:
 
     void SetLabelText(const wxString& text)
     {
-        return SetLabel(EscapeMnemonics(text));
+        SetLabel(EscapeMnemonics(text));
     }
 
-    // static utilities:
+    // 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
+    virtual bool ShouldInheritColours() const { return true; }
 
-    // replaces parts of the string with ellipsis if needed
+
+    // WARNING: this doesn't work for all controls nor all platforms!
+    //
+    // simulates the event of given type (i.e. wxButton::Command() is just as
+    // if the button was clicked)
+    virtual void Command(wxCommandEvent &event);
+
+    virtual bool SetFont(const wxFont& font);
+
+    // wxControl-specific processing after processing the update event
+    virtual void DoUpdateWindowUI(wxUpdateUIEvent& event);
+
+
+
+    // 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);
+                              wxEllipsizeMode mode, int maxWidth,
+                              int flags = wxELLIPSIZE_FLAGS_DEFAULT);
 
     // get the string without mnemonic characters ('&')
     static wxString GetLabelText(const wxString& label);
@@ -97,23 +136,12 @@ public:
     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
-    // ShouldInheritColours() to return false
-    virtual bool ShouldInheritColours() const { return true; }
-
-
-    // WARNING: this doesn't work for all controls nor all platforms!
-    //
-    // simulates the event of given type (i.e. wxButton::Command() is just as
-    // if the button was clicked)
-    virtual void Command(wxCommandEvent &event);
-
-    virtual bool SetFont(const wxFont& font);
-
-    // wxControl-specific processing after processing the update event
-    virtual void DoUpdateWindowUI(wxUpdateUIEvent& event);
+    // this is a helper for the derived class GetClassDefaultAttributes()
+    // implementation: it returns the right colours for the classes which
+    // contain something else (e.g. wxListBox, wxTextCtrl, ...) instead of
+    // being simple controls (such as wxButton, wxCheckBox, ...)
+    static wxVisualAttributes
+        GetCompositeControlsDefaultAttributes(wxWindowVariant variant);
 
 protected:
     // choose the default border for this window
@@ -132,10 +160,15 @@ protected:
     // initialize the common fields of wxCommandEvent
     void InitCommandEvent(wxCommandEvent& event) const;
 
+    // Ellipsize() helper:
+    static wxString DoEllipsizeSingleLine(const wxString& label, const wxDC& dc,
+                                          wxEllipsizeMode mode, int maxWidth,
+                                          int replacementWidth, int marginWidth);
+
     // this field contains the label in wx format, i.e. with '&' mnemonics
     wxString m_labelOrig;
 
-    DECLARE_NO_COPY_CLASS(wxControlBase)
+    wxDECLARE_NO_COPY_CLASS(wxControlBase);
 };
 
 // ----------------------------------------------------------------------------