include/wx/univ/window.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/univ/window.h
   3 // Purpose:     wxWindow class which is the base class for all
   4 //              wxUniv port controls, it supports the customization of the
   5 //              window drawing and input processing.
   6 // Author:      Vadim Zeitlin
   7 // Modified by:
   8 // Created:     06.08.00
   9 // RCS-ID:      $Id$
  10 // Copyright:   (c) 2000 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
  11 // Licence:     wxWindows license
  12 ///////////////////////////////////////////////////////////////////////////////
  13
  14 #ifndef _WX_UNIV_WINDOW_H_
  15 #define _WX_UNIV_WINDOW_H_
  16
  17 #ifdef __GNUG__
  18     #pragma interface "univwindow.h"
  19 #endif
  20
  21 #include "wx/bitmap.h"      // for m_bitmapBg
  22
  23 class WXDLLEXPORT wxControlRenderer;
  24 class WXDLLEXPORT wxEventLoop;
  25 class WXDLLEXPORT wxMenu;
  26 class WXDLLEXPORT wxMenuBar;
  27 class WXDLLEXPORT wxRenderer;
  28 class WXDLLEXPORT wxScrollBar;
  29
  30 // ----------------------------------------------------------------------------
  31 // constants
  32 // ----------------------------------------------------------------------------
  33
  34 // control state flags used in wxRenderer and wxColourScheme
  35 enum
  36 {
  37     wxCONTROL_DISABLED   = 0x00000001,  // control is disabled
  38     wxCONTROL_FOCUSED    = 0x00000002,  // currently has keyboard focus
  39     wxCONTROL_PRESSED    = 0x00000004,  // (button) is pressed
  40     wxCONTROL_ISDEFAULT  = 0x00000008,  // only applies to the buttons
  41     wxCONTROL_ISSUBMENU  = wxCONTROL_ISDEFAULT, // only for menu items
  42     wxCONTROL_CURRENT    = 0x00000010,  // mouse is currently over the control
  43     wxCONTROL_SELECTED   = 0x00000020,  // selected item in e.g. listbox
  44     wxCONTROL_CHECKED    = 0x00000040,  // (check/radio button) is checked
  45     wxCONTROL_CHECKABLE  = 0x00000080,  // (menu) item can be checked
  46
  47     wxCONTROL_FLAGS_MASK = 0x000000ff,
  48
  49     // this is a pseudo flag not used directly by wxRenderer but rather by some
  50     // controls internally
  51     wxCONTROL_DIRTY      = 0x80000000
  52 };
  53
  54 // ----------------------------------------------------------------------------
  55 // wxWindow
  56 // ----------------------------------------------------------------------------
  57
  58 #if defined(__WXMSW__)
  59 #define wxWindowNative wxWindowMSW
  60 #elif defined(__WXGTK__)
  61 #define wxWindowNative wxWindowGTK
  62 #elif defined(__WXMGL__)
  63 #define wxWindowNative wxWindowMGL
  64 #endif
  65
  66 class WXDLLEXPORT wxWindow : public wxWindowNative
  67 {
  68 public:
  69     // ctors and create functions
  70     // ---------------------------
  71
  72     wxWindow() { Init(); }
  73
  74     wxWindow(wxWindow *parent,
  75              wxWindowID id,
  76              const wxPoint& pos = wxDefaultPosition,
  77              const wxSize& size = wxDefaultSize,
  78              long style = 0,
  79              const wxString& name = wxPanelNameStr)
  80         : wxWindowNative(parent, id, pos, size, style | wxCLIP_CHILDREN, name)
  81         { Init(); }
  82
  83     bool Create(wxWindow *parent,
  84                 wxWindowID id,
  85                 const wxPoint& pos = wxDefaultPosition,
  86                 const wxSize& size = wxDefaultSize,
  87                 long style = 0,
  88                 const wxString& name = wxPanelNameStr);
  89
  90     // background pixmap support
  91     // -------------------------
  92
  93     virtual void SetBackground(const wxBitmap& bitmap,
  94                                int alignment = wxALIGN_CENTRE,
  95                                wxStretch stretch = wxSTRETCH_NOT);
  96
  97     const wxBitmap& GetBackgroundBitmap(int *alignment = NULL,
  98                                         wxStretch *stretch = NULL) const;
  99
 100     // scrollbars: we (re)implement it ourselves using our own scrollbars
 101     // instead of the native ones
 102     // ------------------------------------------------------------------
 103
 104     virtual void SetScrollbar(int orient,
 105                               int pos,
 106                               int page,
 107                               int range,
 108                               bool refresh = TRUE );
 109     virtual void SetScrollPos(int orient, int pos, bool refresh = TRUE);
 110     virtual int GetScrollPos(int orient) const;
 111     virtual int GetScrollThumb(int orient) const;
 112     virtual int GetScrollRange(int orient) const;
 113     virtual void ScrollWindow(int dx, int dy,
 114                               const wxRect* rect = (wxRect *) NULL);
 115
 116     // take into account the borders here
 117     virtual wxPoint GetClientAreaOrigin() const;
 118
 119     // popup menu support
 120     // ------------------
 121
 122     // NB: all menu related functions are implemented in menu.cpp
 123
 124 #if wxUSE_MENUS
 125     virtual bool DoPopupMenu(wxMenu *menu, int x, int y);
 126
 127     // this is wxUniv-specific private method to be used only by wxMenu
 128     void DismissPopupMenu();
 129 #endif // wxUSE_MENUS
 130
 131     // miscellaneous other methods
 132     // ---------------------------
 133
 134     // get the state information
 135     virtual bool IsFocused() const;
 136     virtual bool IsCurrent() const;
 137     virtual bool IsPressed() const;
 138     virtual bool IsDefault() const;
 139
 140     // return all state flags at once (combination of wxCONTROL_XXX values)
 141     int GetStateFlags() const;
 142
 143     // set the "highlighted" flag and return TRUE if it changed
 144     virtual bool SetCurrent(bool doit = TRUE);
 145
 146     // get the scrollbar (may be NULL) for the given orientation
 147     wxScrollBar *GetScrollbar(int orient) const
 148     {
 149         return orient & wxVERTICAL ? m_scrollbarVert : m_scrollbarHorz;
 150     }
 151
 152     // methods used by wxColourScheme to choose the colours for this window
 153     // --------------------------------------------------------------------
 154
 155     // return TRUE if this is a panel/canvas window which contains other
 156     // controls only
 157     virtual bool IsCanvasWindow() const { return FALSE; }
 158
 159     // return TRUE if this a container window which contains the other items:
 160     // e.g, a listbox, listctrl, treectrl, ... and FALSE if it is a monolithic
 161     // control (e.g. a button, checkbox, ...)
 162     virtual bool IsContainerWindow() const { return FALSE; }
 163
 164     // return TRUE if this control can be highlighted when the mouse is over
 165     // it (the theme decides itself whether it is really highlighted or not)
 166     virtual bool CanBeHighlighted() const { return FALSE; }
 167
 168     // return TRUE if we should use the colours/fonts returned by the
 169     // corresponding GetXXX() methods instead of the default ones
 170     bool UseBgCol() const { return m_hasBgCol; }
 171     bool UseFgCol() const { return m_hasFgCol; }
 172     bool UseFont() const { return m_hasFont; }
 173
 174     // returns the (low level) renderer to use for drawing the control by
 175     // querying the current theme
 176     wxRenderer *GetRenderer() const { return m_renderer; }
 177
 178     // scrolling helper: like ScrollWindow() except that it doesn't refresh the
 179     // uncovered window areas but returns the rectangle to update (don't call
 180     // this with both dx and dy non zero)
 181     wxRect ScrollNoRefresh(int dx, int dy, const wxRect *rect = NULL);
 182
 183     // after scrollbars are added or removed they must be refreshed by calling
 184     // this function
 185     void RefreshScrollbars();
 186
 187     // erase part of the control
 188     virtual void EraseBackground(wxDC& dc, const wxRect& rect);
 189
 190     // overridden base class methods
 191     // -----------------------------
 192
 193     // the rect coordinates are, for us, in client coords, but if no rect is
 194     // specified, the entire window is refreshed
 195     virtual void Refresh(bool eraseBackground = TRUE,
 196                          const wxRect *rect = (const wxRect *) NULL);
 197
 198     // we refresh the window when it is dis/enabled
 199     virtual bool Enable(bool enable = TRUE);
 200
 201     // remember that the font/colour was changed
 202     virtual bool SetBackgroundColour(const wxColour& colour);
 203     virtual bool SetForegroundColour(const wxColour& colour);
 204     virtual bool SetFont(const wxFont& font);
 205
 206     // our Capture/ReleaseMouse() maintains the stack of windows which had
 207     // captured the mouse and when ReleaseMouse() is called, the mouse freed
 208     // only if the stack is empty, otherwise it is captured back by the window
 209     // on top of the stack
 210     virtual void CaptureMouse();
 211     virtual void ReleaseMouse();
 212
 213 protected:
 214     // common part of all ctors
 215     void Init();
 216
 217     // overridden base class virtuals
 218
 219     // we deal with the scrollbars in these functions
 220     virtual void DoSetClientSize(int width, int height);
 221     virtual void DoGetClientSize(int *width, int *height) const;
 222     virtual wxHitTest DoHitTest(wxCoord x, wxCoord y) const;
 223
 224     // event handlers
 225     void OnSize(wxSizeEvent& event);
 226     void OnNcPaint(wxPaintEvent& event);
 227     void OnPaint(wxPaintEvent& event);
 228     void OnErase(wxEraseEvent& event);
 229
 230 #if wxUSE_ACCEL || wxUSE_MENUS
 231     void OnKeyDown(wxKeyEvent& event);
 232 #endif // wxUSE_ACCEL
 233
 234 #if wxUSE_MENUS
 235     void OnChar(wxKeyEvent& event);
 236     void OnKeyUp(wxKeyEvent& event);
 237 #endif // wxUSE_MENUS
 238
 239     // draw the control background, return TRUE if done
 240     virtual bool DoDrawBackground(wxDC& dc);
 241
 242     // draw the controls border
 243     virtual void DoDrawBorder(wxDC& dc, const wxRect& rect);
 244
 245     // draw the controls contents
 246     virtual void DoDraw(wxControlRenderer *renderer);
 247
 248     // calculate the best size for the client area of the window: default
 249     // implementation of DoGetBestSize() uses this method and adds the border
 250     // width to the result
 251     virtual wxSize DoGetBestClientSize() const;
 252     virtual wxSize DoGetBestSize() const;
 253
 254     // adjust the size of the window to take into account its borders
 255     wxSize AdjustSize(const wxSize& size) const;
 256
 257     // put the scrollbars along the edges of the window
 258     void PositionScrollbars();
 259
 260 #if wxUSE_MENUS
 261     // return the menubar of the parent frame or NULL
 262     wxMenuBar *GetParentFrameMenuBar() const;
 263 #endif // wxUSE_MENUS
 264
 265     // the renderer we use
 266     wxRenderer *m_renderer;
 267
 268     // background bitmap info
 269     wxBitmap  m_bitmapBg;
 270     int       m_alignBgBitmap;
 271     wxStretch m_stretchBgBitmap;
 272
 273     // more flags
 274     bool m_isCurrent:1; // is the mouse currently inside the window?
 275     bool m_hasBgCol:1;  // was the bg colour explicitly changed by user?
 276     bool m_hasFgCol:1;  //         fg
 277     bool m_hasFont:1;   //         font
 278
 279 private:
 280     // the window scrollbars
 281     wxScrollBar *m_scrollbarHorz,
 282                 *m_scrollbarVert;
 283
 284     // the stack of windows which have captured the mouse
 285     static struct WXDLLEXPORT wxWindowNext *ms_winCaptureNext;
 286
 287 #if wxUSE_MENUS
 288     // the current modal event loop for the popup menu we show or NULL
 289     static wxEventLoop *ms_evtLoopPopup;
 290
 291     // the last window over which Alt was pressed (used by OnKeyUp)
 292     static wxWindow *ms_winLastAltPress;
 293 #endif // wxUSE_MENUS
 294
 295     DECLARE_DYNAMIC_CLASS(wxWindow)
 296     DECLARE_EVENT_TABLE()
 297 };
 298
 299 #endif // _WX_UNIV_WINDOW_H_
 300