include/wx/palmos/control.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/palmos/control.h
   3 // Purpose:     wxControl class
   4 // Author:      William Osborne - minimal working wxPalmOS port
   5 // Modified by: Wlodzimierz ABX Skiba - native implementation
   6 // Created:     10/13/04
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) William Osborne, Wlodzimierz Skiba
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_CONTROL_H_
  13 #define _WX_CONTROL_H_
  14
  15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  16     #pragma interface "control.h"
  17 #endif
  18
  19 #include "wx/dynarray.h"
  20
  21 // General item class
  22 class WXDLLEXPORT wxControl : public wxControlBase
  23 {
  24 public:
  25     wxControl() { Init(); }
  26
  27     wxControl(wxWindow *parent, wxWindowID id,
  28               const wxPoint& pos = wxDefaultPosition,
  29               const wxSize& size = wxDefaultSize, long style = 0,
  30               const wxValidator& validator = wxDefaultValidator,
  31               const wxString& name = wxControlNameStr)
  32     {
  33         Init();
  34         Create(parent, id, pos, size, style, validator, name);
  35     }
  36
  37     bool Create(wxWindow *parent, wxWindowID id,
  38             const wxPoint& pos = wxDefaultPosition,
  39             const wxSize& size = wxDefaultSize, long style = 0,
  40             const wxValidator& validator = wxDefaultValidator,
  41             const wxString& name = wxControlNameStr);
  42
  43     virtual ~wxControl();
  44
  45     // Simulates an event
  46     virtual void Command(wxCommandEvent& event) { ProcessCommand(event); }
  47
  48     virtual bool Enable( bool enable = true );
  49     virtual bool IsEnabled() const;
  50
  51     virtual bool Show( bool show = true );
  52     virtual bool IsShown() const;
  53
  54     virtual void SetLabel(const wxString& label);
  55     virtual wxString GetLabel();
  56
  57     // implementation from now on
  58     // --------------------------
  59
  60     virtual wxVisualAttributes GetDefaultAttributes() const
  61     {
  62         return GetClassDefaultAttributes(GetWindowVariant());
  63     }
  64
  65     static wxVisualAttributes
  66     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
  67
  68     // Calls the callback and appropriate event handlers
  69     bool ProcessCommand(wxCommandEvent& event);
  70
  71     const wxArrayLong& GetSubcontrols() const { return m_subControls; }
  72
  73     void OnEraseBackground(wxEraseEvent& event);
  74
  75 protected:
  76     // regardless how deeply we are in wxWidgets hierarchy always get correct form
  77     FormType* GetParentForm() const;
  78     FormType* GetObjectFormIndex(uint16_t& index) const;
  79     void* GetObjectPtr() const;
  80
  81     // choose the default border for this window
  82     virtual wxBorder GetDefaultBorder() const;
  83
  84     // on/off-like controls
  85     void SetBoolValue(bool value);
  86     bool GetBoolValue() const;
  87     void SetIntValue(int val);
  88
  89     // native labels access
  90     void SetFieldLabel(const wxString& label);
  91     void SetControlLabel(const wxString& label);
  92     wxString GetFieldLabel();
  93     wxString GetControlLabel();
  94
  95     // return default best size (doesn't really make any sense, override this)
  96     virtual wxSize DoGetBestSize() const;
  97
  98     // getting and setting sizes
  99     virtual void DoGetPosition( int *x, int *y ) const;
 100     virtual void DoGetSize( int *width, int *height ) const;
 101     virtual void DoMoveWindow(int x, int y, int width, int height);
 102
 103     // create the control of the given ControlStyleType: this is typically called
 104     // from Create() method of the derived class passing its label, pos and
 105     // size parameter (style parameter is not needed because m_windowStyle is
 106     // supposed to had been already set and so is used instead when this
 107     // function is called)
 108     bool PalmCreateControl(ControlStyleType style,
 109                            const wxString& label,
 110                            const wxPoint& pos,
 111                            const wxSize& size,
 112                            uint8_t groupID = 0);
 113     inline bool IsPalmControl() const { return m_palmControl; }
 114
 115     bool PalmCreateField(const wxString& label,
 116                          const wxPoint& pos,
 117                          const wxSize& size,
 118                          bool editable,
 119                          bool underlined,
 120                          JustificationType justification);
 121     inline bool IsPalmField() const { return m_palmField; }
 122
 123     // this is a helper for the derived class GetClassDefaultAttributes()
 124     // implementation: it returns the right colours for the classes which
 125     // contain something else (e.g. wxListBox, wxTextCtrl, ...) instead of
 126     // being simple controls (such as wxButton, wxCheckBox, ...)
 127     static wxVisualAttributes
 128         GetCompositeControlsDefaultAttributes(wxWindowVariant variant);
 129
 130
 131     // for controls like radiobuttons which are really composite this array
 132     // holds the ids (not HWNDs!) of the sub controls
 133     wxArrayLong m_subControls;
 134
 135     // m_label stores label in case of wxButton, wxCheckBox, wxToggleButton etc.
 136     // We must ensure that it persists for as long as it is being displayed
 137     // (that is, for as long as the control is displayed or until we call
 138     // CtlSetLabel() with a new string), and we must free the string after
 139     // it is no longer in use (typically after the form containing the
 140     // control is freed).
 141     wxString m_label;
 142
 143 private:
 144
 145     bool m_palmControl:1;
 146     bool m_palmField:1;
 147
 148     // common part of all ctors
 149     void Init();
 150
 151     virtual void DoGetBounds( RectangleType &rect ) const;
 152     virtual void DoSetBounds( RectangleType &rect );
 153
 154     DECLARE_DYNAMIC_CLASS_NO_COPY(wxControl)
 155     DECLARE_EVENT_TABLE()
 156 };
 157
 158 #endif
 159     // _WX_CONTROL_H_