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