X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f03fc89fff2d6e823e7d4d14fbe14822ad6777b1..a2c5db764c8450dda6e87fe58917b0a00ec2c74f:/include/wx/control.h diff --git a/include/wx/control.h b/include/wx/control.h index 40bc3ab8fd..cf939b5459 100644 --- a/include/wx/control.h +++ b/include/wx/control.h @@ -1,22 +1,144 @@ +///////////////////////////////////////////////////////////////////////////// +// Name: wx/control.h +// Purpose: wxControl common interface +// Author: Vadim Zeitlin +// Modified by: +// Created: 26.07.99 +// RCS-ID: $Id$ +// Copyright: (c) wxWidgets team +// Licence: wxWindows licence +///////////////////////////////////////////////////////////////////////////// + #ifndef _WX_CONTROL_H_BASE_ #define _WX_CONTROL_H_BASE_ -// all classes derived from wxControl need the validators -#include "wx/validate.h" +// ---------------------------------------------------------------------------- +// headers +// ---------------------------------------------------------------------------- + +#include "wx/defs.h" + +#if wxUSE_CONTROLS + +#include "wx/window.h" // base class + +extern WXDLLEXPORT_DATA(const wxChar) wxControlNameStr[]; + +// ---------------------------------------------------------------------------- +// wxControl is the base class for all controls +// ---------------------------------------------------------------------------- + +class WXDLLEXPORT wxControlBase : public wxWindow +{ +public: + wxControlBase() { } + + virtual ~wxControlBase(); + + // Create() function adds the validator parameter + bool Create(wxWindow *parent, wxWindowID id, + const wxPoint& pos = wxDefaultPosition, + const wxSize& size = wxDefaultSize, + long style = 0, + const wxValidator& validator = wxDefaultValidator, + const wxString& name = wxControlNameStr); + + // get the control alignment (left/right/centre, top/bottom/centre) + int GetAlignment() const { return m_windowStyle & wxALIGN_MASK; } + + // get just the text of the label, without mnemonic characters ('&') + wxString GetLabelText() const { return GetLabelText(GetLabel()); } + + 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; + } + + // static utilities: -#if defined(__WXMSW__) -#include "wx/msw/control.h" + // get the string without mnemonic characters ('&') + static wxString GetLabelText(const wxString& label); + + // removes the mnemonics characters + static wxString RemoveMnemonics(const wxString& str); + + // escapes the mnemonics characters ('&') by doubling them + static wxString EscapeMnemonics(const wxString& str); + + + // 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); + +protected: + // creates the control (calls wxWindowBase::CreateBase inside) and adds it + // to the list of parents children + bool CreateControl(wxWindowBase *parent, + wxWindowID id, + const wxPoint& pos, + const wxSize& size, + long style, + const wxValidator& validator, + const wxString& name); + + // initialize the common fields of wxCommandEvent + void InitCommandEvent(wxCommandEvent& event) const; + + // this field contains the label in wx format, i.e. with '&' mnemonics + wxString m_labelOrig; + + DECLARE_NO_COPY_CLASS(wxControlBase) +}; + +// ---------------------------------------------------------------------------- +// include platform-dependent wxControl declarations +// ---------------------------------------------------------------------------- + +#if defined(__WXUNIVERSAL__) + #include "wx/univ/control.h" +#elif defined(__WXPALMOS__) + #include "wx/palmos/control.h" +#elif defined(__WXMSW__) + #include "wx/msw/control.h" #elif defined(__WXMOTIF__) -#include "wx/motif/control.h" + #include "wx/motif/control.h" +#elif defined(__WXGTK20__) + #include "wx/gtk/control.h" #elif defined(__WXGTK__) -#include "wx/gtk/control.h" -#elif defined(__WXQT__) -#include "wx/qt/control.h" + #include "wx/gtk1/control.h" #elif defined(__WXMAC__) -#include "wx/mac/control.h" -#elif defined(__WXSTUBS__) -#include "wx/stubs/control.h" + #include "wx/mac/control.h" +#elif defined(__WXCOCOA__) + #include "wx/cocoa/control.h" +#elif defined(__WXPM__) + #include "wx/os2/control.h" #endif +#endif // wxUSE_CONTROLS + #endif // _WX_CONTROL_H_BASE_