include/wx/dfb/window.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/dfb/window.h
   3 // Purpose:     wxWindow class
   4 // Author:      Vaclav Slavik
   5 // Created:     2006-08-10
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) 2006 REA Elektronik GmbH
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_DFB_WINDOW_H_
  12 #define _WX_DFB_WINDOW_H_
  13
  14 // ---------------------------------------------------------------------------
  15 // headers
  16 // ---------------------------------------------------------------------------
  17
  18 #include "wx/dfb/dfbptr.h"
  19
  20 wxDFB_DECLARE_INTERFACE(IDirectFBSurface);
  21 struct wxDFBWindowEvent;
  22
  23 class WXDLLIMPEXP_FWD_CORE wxFont;
  24 class WXDLLIMPEXP_FWD_CORE wxNonOwnedWindow;
  25
  26 class wxOverlayImpl;
  27 class wxDfbOverlaysList;
  28
  29 // ---------------------------------------------------------------------------
  30 // wxWindow
  31 // ---------------------------------------------------------------------------
  32
  33 class WXDLLIMPEXP_CORE wxWindowDFB : public wxWindowBase
  34 {
  35 public:
  36     wxWindowDFB() { Init(); }
  37
  38     wxWindowDFB(wxWindow *parent,
  39                 wxWindowID id,
  40                 const wxPoint& pos = wxDefaultPosition,
  41                 const wxSize& size = wxDefaultSize,
  42                 long style = 0,
  43                 const wxString& name = wxPanelNameStr)
  44     {
  45         Init();
  46         Create(parent, id, pos, size, style, name);
  47     }
  48
  49     virtual ~wxWindowDFB();
  50
  51     bool Create(wxWindow *parent,
  52                 wxWindowID id,
  53                 const wxPoint& pos = wxDefaultPosition,
  54                 const wxSize& size = wxDefaultSize,
  55                 long style = 0,
  56                 const wxString& name = wxPanelNameStr);
  57
  58     // implement base class (pure) virtual methods
  59     // -------------------------------------------
  60
  61     virtual void SetLabel( const wxString &WXUNUSED(label) ) {}
  62     virtual wxString GetLabel() const { return wxEmptyString; }
  63
  64     virtual void Raise();
  65     virtual void Lower();
  66
  67     virtual bool Show(bool show = true);
  68
  69     virtual void SetFocus();
  70
  71     virtual bool Reparent(wxWindowBase *newParent);
  72
  73     virtual void WarpPointer(int x, int y);
  74
  75     virtual void Refresh(bool eraseBackground = true,
  76                          const wxRect *rect = (const wxRect *) NULL);
  77     virtual void Update();
  78
  79     virtual bool SetCursor(const wxCursor &cursor);
  80     virtual bool SetFont(const wxFont &font) { m_font = font; return true; }
  81
  82     virtual int GetCharHeight() const;
  83     virtual int GetCharWidth() const;
  84
  85 #if wxUSE_DRAG_AND_DROP
  86     virtual void SetDropTarget(wxDropTarget *dropTarget);
  87
  88     // Accept files for dragging
  89     virtual void DragAcceptFiles(bool accept);
  90 #endif // wxUSE_DRAG_AND_DROP
  91
  92     virtual WXWidget GetHandle() const { return this; }
  93
  94     // implementation from now on
  95     // --------------------------
  96
  97     // Returns DirectFB surface used for rendering of this window
  98     wxIDirectFBSurfacePtr GetDfbSurface();
  99
 100     // returns toplevel window the window belongs to
 101     wxNonOwnedWindow *GetTLW() const { return m_tlw; }
 102
 103     virtual bool IsDoubleBuffered() const { return true; }
 104
 105 protected:
 106     // implement the base class pure virtuals
 107     virtual void DoGetTextExtent(const wxString& string,
 108                                  int *x, int *y,
 109                                  int *descent = NULL,
 110                                  int *externalLeading = NULL,
 111                                  const wxFont *theFont = NULL) const;
 112     virtual void DoClientToScreen(int *x, int *y) const;
 113     virtual void DoScreenToClient(int *x, int *y) const;
 114     virtual void DoGetPosition(int *x, int *y) const;
 115     virtual void DoGetSize(int *width, int *height) const;
 116     virtual void DoGetClientSize(int *width, int *height) const;
 117     virtual void DoSetSize(int x, int y,
 118                            int width, int height,
 119                            int sizeFlags = wxSIZE_AUTO);
 120     virtual void DoSetClientSize(int width, int height);
 121
 122     virtual void DoCaptureMouse();
 123     virtual void DoReleaseMouse();
 124
 125     virtual void DoThaw();
 126
 127     // move the window to the specified location and resize it: this is called
 128     // from both DoSetSize() and DoSetClientSize() and would usually just call
 129     // ::MoveWindow() except for composite controls which will want to arrange
 130     // themselves inside the given rectangle
 131     virtual void DoMoveWindow(int x, int y, int width, int height);
 132
 133     // return DFB surface used to render this window (will be assigned to
 134     // m_surface if the window is visible)
 135     virtual wxIDirectFBSurfacePtr ObtainDfbSurface() const;
 136
 137     // this method must be called when window's position, size or visibility
 138     // changes; it resets m_surface so that ObtainDfbSurface has to be called
 139     // next time GetDfbSurface is called
 140     void InvalidateDfbSurface();
 141
 142     // called by parent to render (part of) the window
 143     void PaintWindow(const wxRect& rect);
 144
 145     // paint window's overlays (if any) on top of window's surface
 146     void PaintOverlays(const wxRect& rect);
 147
 148     // refreshes the entire window (including non-client areas)
 149     void DoRefreshWindow();
 150     // refreshes given rectangle of the window (in window, _not_ client coords)
 151     virtual void DoRefreshRect(const wxRect& rect);
 152     // refreshes given rectangle; unlike RefreshRect(), the argument is in
 153     // window, not client, coords and unlike DoRefreshRect() and like Refresh(),
 154     // does nothing if the window is hidden or frozen
 155     void RefreshWindowRect(const wxRect& rect);
 156
 157     // add/remove overlay for this window
 158     void AddOverlay(wxOverlayImpl *overlay);
 159     void RemoveOverlay(wxOverlayImpl *overlay);
 160
 161     // DirectFB events handling
 162     void HandleKeyEvent(const wxDFBWindowEvent& event_);
 163
 164 private:
 165     // common part of all ctors
 166     void Init();
 167     // counterpart to SetFocus
 168     void DFBKillFocus();
 169
 170 protected:
 171     // toplevel window (i.e. DirectFB window) this window belongs to
 172     wxNonOwnedWindow *m_tlw;
 173
 174 private:
 175     // subsurface of TLW's surface covered by this window
 176     wxIDirectFBSurfacePtr m_surface;
 177
 178     // position of the window (relative to the parent, not used by wxTLW, so
 179     // don't access it directly)
 180     wxRect m_rect;
 181
 182     // overlays for this window (or NULL if it doesn't have any)
 183     wxDfbOverlaysList *m_overlays;
 184
 185     friend class wxNonOwnedWindow; // for HandleXXXEvent
 186     friend class wxOverlayImpl; // for Add/RemoveOverlay
 187     friend class wxWindowDCImpl; // for PaintOverlays
 188
 189     DECLARE_DYNAMIC_CLASS(wxWindowDFB)
 190     wxDECLARE_NO_COPY_CLASS(wxWindowDFB);
 191     DECLARE_EVENT_TABLE()
 192 };
 193
 194 #endif // _WX_DFB_WINDOW_H_