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 SciTech Software, Inc. (www.scitechsoft.com)
  11 // Licence:     wxWindows licence
  12 ///////////////////////////////////////////////////////////////////////////////
  13
  14 #ifndef _WX_UNIV_WINDOW_H_
  15 #define _WX_UNIV_WINDOW_H_
  16
  17 #include "wx/bitmap.h"      // for m_bitmapBg
  18
  19 class WXDLLIMPEXP_FWD_CORE wxControlRenderer;
  20 class WXDLLIMPEXP_FWD_CORE wxEventLoop;
  21
  22 #if wxUSE_MENUS
  23     class WXDLLIMPEXP_FWD_CORE wxMenu;
  24     class WXDLLIMPEXP_FWD_CORE wxMenuBar;
  25 #endif // wxUSE_MENUS
  26
  27 class WXDLLIMPEXP_FWD_CORE wxRenderer;
  28
  29 #if wxUSE_SCROLLBAR
  30     class WXDLLIMPEXP_FWD_CORE wxScrollBar;
  31 #endif // wxUSE_SCROLLBAR
  32
  33 #ifdef __WXX11__
  34 #define wxUSE_TWO_WINDOWS 1
  35 #else
  36 #define wxUSE_TWO_WINDOWS 0
  37 #endif
  38
  39 // ----------------------------------------------------------------------------
  40 // wxWindow
  41 // ----------------------------------------------------------------------------
  42
  43 #if defined(__WXMSW__)
  44 #define wxWindowNative wxWindowMSW
  45 #elif defined(__WXGTK__)
  46 #define wxWindowNative wxWindowGTK
  47 #elif defined(__WXMGL__)
  48 #define wxWindowNative wxWindowMGL
  49 #elif defined(__WXX11__)
  50 #define wxWindowNative wxWindowX11
  51 #elif defined(__WXMAC__)
  52 #define wxWindowNative wxWindowMac
  53 #endif
  54
  55 class WXDLLIMPEXP_CORE wxWindow : public wxWindowNative
  56 {
  57 public:
  58     // ctors and create functions
  59     // ---------------------------
  60
  61     wxWindow() { Init(); }
  62
  63     wxWindow(wxWindow *parent,
  64              wxWindowID id,
  65              const wxPoint& pos = wxDefaultPosition,
  66              const wxSize& size = wxDefaultSize,
  67              long style = 0,
  68              const wxString& name = wxPanelNameStr)
  69         : wxWindowNative(parent, id, pos, size, style | wxCLIP_CHILDREN, name)
  70         { Init(); }
  71
  72     bool Create(wxWindow *parent,
  73                 wxWindowID id,
  74                 const wxPoint& pos = wxDefaultPosition,
  75                 const wxSize& size = wxDefaultSize,
  76                 long style = 0,
  77                 const wxString& name = wxPanelNameStr);
  78
  79     virtual ~wxWindow();
  80
  81     // background pixmap support
  82     // -------------------------
  83
  84     virtual void SetBackground(const wxBitmap& bitmap,
  85                                int alignment = wxALIGN_CENTRE,
  86                                wxStretch stretch = wxSTRETCH_NOT);
  87
  88     const wxBitmap& GetBackgroundBitmap(int *alignment = NULL,
  89                                         wxStretch *stretch = NULL) const;
  90
  91     // scrollbars: we (re)implement it ourselves using our own scrollbars
  92     // instead of the native ones
  93     // ------------------------------------------------------------------
  94
  95     virtual void SetScrollbar(int orient,
  96                               int pos,
  97                               int page,
  98                               int range,
  99                               bool refresh = true );
 100     virtual void SetScrollPos(int orient, int pos, bool refresh = true);
 101     virtual int GetScrollPos(int orient) const;
 102     virtual int GetScrollThumb(int orient) const;
 103     virtual int GetScrollRange(int orient) const;
 104     virtual void ScrollWindow(int dx, int dy,
 105                               const wxRect* rect = (wxRect *) NULL);
 106
 107     // take into account the borders here
 108     virtual wxPoint GetClientAreaOrigin() const;
 109
 110     // popup menu support
 111     // ------------------
 112
 113     // NB: all menu related functions are implemented in menu.cpp
 114
 115 #if wxUSE_MENUS
 116     // this is wxUniv-specific private method to be used only by wxMenu
 117     void DismissPopupMenu();
 118 #endif // wxUSE_MENUS
 119
 120     // miscellaneous other methods
 121     // ---------------------------
 122
 123     // get the state information
 124     virtual bool IsFocused() const;
 125     virtual bool IsCurrent() const;
 126     virtual bool IsPressed() const;
 127     virtual bool IsDefault() const;
 128
 129     // return all state flags at once (combination of wxCONTROL_XXX values)
 130     int GetStateFlags() const;
 131
 132     // set the "highlighted" flag and return true if it changed
 133     virtual bool SetCurrent(bool doit = true);
 134
 135 #if wxUSE_SCROLLBAR
 136     // get the scrollbar (may be NULL) for the given orientation
 137     wxScrollBar *GetScrollbar(int orient) const
 138     {
 139         return orient & wxVERTICAL ? m_scrollbarVert : m_scrollbarHorz;
 140     }
 141 #endif // wxUSE_SCROLLBAR
 142
 143     // methods used by wxColourScheme to choose the colours for this window
 144     // --------------------------------------------------------------------
 145
 146     // return true if this is a panel/canvas window which contains other
 147     // controls only
 148     virtual bool IsCanvasWindow() const { return false; }
 149
 150     // return true if this control can be highlighted when the mouse is over
 151     // it (the theme decides itself whether it is really highlighted or not)
 152     virtual bool CanBeHighlighted() const { return false; }
 153
 154     // return true if we should use the colours/fonts returned by the
 155     // corresponding GetXXX() methods instead of the default ones
 156     bool UseFgCol() const { return m_hasFgCol; }
 157     bool UseFont() const { return m_hasFont; }
 158
 159     // return true if this window serves as a container for the other windows
 160     // only and doesn't get any input itself
 161     virtual bool IsStaticBox() const { return false; }
 162
 163     // returns the (low level) renderer to use for drawing the control by
 164     // querying the current theme
 165     wxRenderer *GetRenderer() const { return m_renderer; }
 166
 167     // scrolling helper: like ScrollWindow() except that it doesn't refresh the
 168     // uncovered window areas but returns the rectangle to update (don't call
 169     // this with both dx and dy non zero)
 170     wxRect ScrollNoRefresh(int dx, int dy, const wxRect *rect = NULL);
 171
 172     // after scrollbars are added or removed they must be refreshed by calling
 173     // this function
 174     void RefreshScrollbars();
 175
 176     // erase part of the control
 177     virtual void EraseBackground(wxDC& dc, const wxRect& rect);
 178
 179     // overridden base class methods
 180     // -----------------------------
 181
 182     // the rect coordinates are, for us, in client coords, but if no rect is
 183     // specified, the entire window is refreshed
 184     virtual void Refresh(bool eraseBackground = true,
 185                          const wxRect *rect = (const wxRect *) NULL);
 186
 187     // we refresh the window when it is dis/enabled
 188     virtual bool Enable(bool enable = true);
 189
 190     // should we use the standard control colours or not?
 191     virtual bool ShouldInheritColours() const { return false; }
 192
 193     virtual bool IsClientAreaChild(const wxWindow *child) const
 194     {
 195 #if wxUSE_SCROLLBAR
 196         if ( child == (wxWindow*)m_scrollbarHorz ||
 197              child == (wxWindow*)m_scrollbarVert )
 198             return false;
 199 #endif
 200         return wxWindowNative::IsClientAreaChild(child);
 201     }
 202
 203 protected:
 204     // common part of all ctors
 205     void Init();
 206
 207 #if wxUSE_MENUS
 208     virtual bool DoPopupMenu(wxMenu *menu, int x, int y);
 209 #endif // wxUSE_MENUS
 210
 211     // we deal with the scrollbars in these functions
 212     virtual void DoSetClientSize(int width, int height);
 213     virtual void DoGetClientSize(int *width, int *height) const;
 214     virtual wxHitTest DoHitTest(wxCoord x, wxCoord y) const;
 215
 216     // event handlers
 217     void OnSize(wxSizeEvent& event);
 218     void OnNcPaint(wxNcPaintEvent& event);
 219     void OnPaint(wxPaintEvent& event);
 220     void OnErase(wxEraseEvent& event);
 221
 222 #if wxUSE_ACCEL || wxUSE_MENUS
 223     void OnKeyDown(wxKeyEvent& event);
 224 #endif // wxUSE_ACCEL
 225
 226 #if wxUSE_MENUS
 227     void OnChar(wxKeyEvent& event);
 228     void OnKeyUp(wxKeyEvent& event);
 229 #endif // wxUSE_MENUS
 230
 231     // draw the control background, return true if done
 232     virtual bool DoDrawBackground(wxDC& dc);
 233
 234     // draw the controls border
 235     virtual void DoDrawBorder(wxDC& dc, const wxRect& rect);
 236
 237     // draw the controls contents
 238     virtual void DoDraw(wxControlRenderer *renderer);
 239
 240     // calculate the best size for the client area of the window: default
 241     // implementation of DoGetBestSize() uses this method and adds the border
 242     // width to the result
 243     virtual wxSize DoGetBestClientSize() const;
 244     virtual wxSize DoGetBestSize() const;
 245
 246     // adjust the size of the window to take into account its borders
 247     wxSize AdjustSize(const wxSize& size) const;
 248
 249     // put the scrollbars along the edges of the window
 250     void PositionScrollbars();
 251
 252 #if wxUSE_MENUS
 253     // return the menubar of the parent frame or NULL
 254     wxMenuBar *GetParentFrameMenuBar() const;
 255 #endif // wxUSE_MENUS
 256
 257     // the renderer we use
 258     wxRenderer *m_renderer;
 259
 260     // background bitmap info
 261     wxBitmap  m_bitmapBg;
 262     int       m_alignBgBitmap;
 263     wxStretch m_stretchBgBitmap;
 264
 265     // old size
 266     wxSize m_oldSize;
 267
 268     // is the mouse currently inside the window?
 269     bool m_isCurrent:1;
 270
 271 #ifdef __WXMSW__
 272 public:
 273     // override MSWWindowProc() to process WM_NCHITTEST
 274     WXLRESULT MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
 275 #endif // __WXMSW__
 276
 277 private:
 278
 279 #if wxUSE_SCROLLBAR
 280     // the window scrollbars
 281     wxScrollBar *m_scrollbarHorz,
 282                 *m_scrollbarVert;
 283 #endif // wxUSE_SCROLLBAR
 284
 285 #if wxUSE_MENUS
 286     // the current modal event loop for the popup menu we show or NULL
 287     static wxEventLoop *ms_evtLoopPopup;
 288
 289     // the last window over which Alt was pressed (used by OnKeyUp)
 290     static wxWindow *ms_winLastAltPress;
 291 #endif // wxUSE_MENUS
 292
 293     DECLARE_DYNAMIC_CLASS(wxWindow)
 294     DECLARE_EVENT_TABLE()
 295 };
 296
 297 #endif // _WX_UNIV_WINDOW_H_