include/wx/gtk/window.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/gtk/window.h
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef __GTKWINDOWH__
  11 #define __GTKWINDOWH__
  12
  13 // helper structure that holds class that holds GtkIMContext object and
  14 // some additional data needed for key events processing
  15 struct wxGtkIMData;
  16
  17 //-----------------------------------------------------------------------------
  18 // callback definition for inserting a window (internal)
  19 //-----------------------------------------------------------------------------
  20
  21 class WXDLLIMPEXP_CORE wxWindowGTK;
  22 typedef void (*wxInsertChildFunction)( wxWindowGTK*, wxWindowGTK* );
  23
  24 //-----------------------------------------------------------------------------
  25 // wxWindowGTK
  26 //-----------------------------------------------------------------------------
  27
  28 class WXDLLIMPEXP_CORE wxWindowGTK : public wxWindowBase
  29 {
  30 public:
  31     // creating the window
  32     // -------------------
  33     wxWindowGTK();
  34     wxWindowGTK(wxWindow *parent,
  35                 wxWindowID id,
  36                 const wxPoint& pos = wxDefaultPosition,
  37                 const wxSize& size = wxDefaultSize,
  38                 long style = 0,
  39                 const wxString& name = wxPanelNameStr);
  40     bool Create(wxWindow *parent,
  41                 wxWindowID id,
  42                 const wxPoint& pos = wxDefaultPosition,
  43                 const wxSize& size = wxDefaultSize,
  44                 long style = 0,
  45                 const wxString& name = wxPanelNameStr);
  46     virtual ~wxWindowGTK();
  47
  48     // implement base class (pure) virtual methods
  49     // -------------------------------------------
  50
  51     virtual void SetLabel(const wxString& WXUNUSED(label)) { }
  52     virtual wxString GetLabel() const { return wxEmptyString; }
  53
  54     virtual bool Destroy();
  55
  56     virtual void Raise();
  57     virtual void Lower();
  58
  59     virtual bool Show( bool show = true );
  60     virtual bool Enable( bool enable = true );
  61
  62     virtual void SetWindowStyleFlag( long style );
  63
  64     virtual bool IsRetained() const;
  65
  66     virtual void SetFocus();
  67     virtual bool AcceptsFocus() const;
  68
  69     virtual bool Reparent( wxWindowBase *newParent );
  70
  71     virtual void WarpPointer(int x, int y);
  72
  73     virtual void Refresh( bool eraseBackground = true,
  74                           const wxRect *rect = (const wxRect *) NULL );
  75     virtual void Update();
  76     virtual void ClearBackground();
  77
  78     virtual bool SetBackgroundColour( const wxColour &colour );
  79     virtual bool SetForegroundColour( const wxColour &colour );
  80     virtual bool SetCursor( const wxCursor &cursor );
  81     virtual bool SetFont( const wxFont &font );
  82
  83     virtual bool SetBackgroundStyle(wxBackgroundStyle style) ;
  84
  85     virtual int GetCharHeight() const;
  86     virtual int GetCharWidth() const;
  87     virtual void GetTextExtent(const wxString& string,
  88                                int *x, int *y,
  89                                int *descent = (int *) NULL,
  90                                int *externalLeading = (int *) NULL,
  91                                const wxFont *theFont = (const wxFont *) NULL)
  92                                const;
  93
  94     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
  95                                int range, bool refresh = true );
  96     virtual void SetScrollPos( int orient, int pos, bool refresh = true );
  97     virtual int GetScrollPos( int orient ) const;
  98     virtual int GetScrollThumb( int orient ) const;
  99     virtual int GetScrollRange( int orient ) const;
 100     virtual void ScrollWindow( int dx, int dy,
 101                                const wxRect* rect = (wxRect *) NULL );
 102     virtual bool ScrollLines(int lines);
 103     virtual bool ScrollPages(int pages);
 104
 105 #if wxUSE_DRAG_AND_DROP
 106     virtual void SetDropTarget( wxDropTarget *dropTarget );
 107 #endif // wxUSE_DRAG_AND_DROP
 108
 109     virtual void AddChild( wxWindowBase *child );
 110     virtual void RemoveChild( wxWindowBase *child );
 111
 112     // currently wxGTK2-only
 113     void SetDoubleBuffered(bool on);
 114
 115     // implementation
 116     // --------------
 117
 118     virtual WXWidget GetHandle() const { return m_widget; }
 119
 120     virtual void OnInternalIdle();
 121
 122     // Internal represention of Update()
 123     void GtkUpdate();
 124
 125     // For compatibility across platforms (not in event table)
 126     void OnIdle(wxIdleEvent& WXUNUSED(event)) {}
 127
 128     // wxGTK-specific: called recursively by Enable,
 129     // to give widgets an opportunity to correct their colours after they
 130     // have been changed by Enable
 131     virtual void OnParentEnable( bool WXUNUSED(enable) ) {}
 132
 133     // Used by all window classes in the widget creation process.
 134     bool PreCreation( wxWindowGTK *parent, const wxPoint &pos, const wxSize &size );
 135     void PostCreation();
 136
 137     // Internal addition of child windows. differs from class
 138     // to class not by using virtual functions but by using
 139     // the m_insertCallback.
 140     void DoAddChild(wxWindowGTK *child);
 141
 142     // This methods sends wxPaintEvents to the window. It reads the
 143     // update region, breaks it up into rects and sends an event
 144     // for each rect. It is also responsible for background erase
 145     // events and NC paint events. It is called from "draw" and
 146     // "expose" handlers as well as from ::Update()
 147     void GtkSendPaintEvents();
 148
 149     // The methods below are required because many native widgets
 150     // are composed of several subwidgets and setting a style for
 151     // the widget means setting it for all subwidgets as well.
 152     // also, it is not clear which native widget is the top
 153     // widget where (most of) the input goes. even tooltips have
 154     // to be applied to all subwidgets.
 155     virtual GtkWidget* GetConnectWidget();
 156     virtual bool IsOwnGtkWindow( GdkWindow *window );
 157     void ConnectWidget( GtkWidget *widget );
 158
 159 protected:
 160     // Override GTKWidgetNeedsMnemonic and return true if your
 161     // needs to set its mnemonic widget, such as for a
 162     // GtkLabel for wxStaticText, then do the actual
 163     // setting of the widget inside GTKWidgetDoSetMnemonic
 164     virtual bool GTKWidgetNeedsMnemonic() const;
 165     virtual void GTKWidgetDoSetMnemonic(GtkWidget* w);
 166
 167 public:
 168     // Returns the default context which usually is anti-aliased
 169     PangoContext   *GtkGetPangoDefaultContext();
 170
 171 #if wxUSE_TOOLTIPS
 172     virtual void ApplyToolTip( GtkTooltips *tips, const wxChar *tip );
 173 #endif // wxUSE_TOOLTIPS
 174
 175     // Called from GTK signal handlers. it indicates that
 176     // the layouting functions have to be called later on
 177     // (i.e. in idle time, implemented in OnInternalIdle() ).
 178     void GtkUpdateSize() { m_sizeSet = false; }
 179
 180
 181     // Called when a window should delay showing itself
 182     // until idle time. This partly mimmicks defered
 183     // sizing under MSW.
 184     void GtkShowOnIdle() { m_showOnIdle = true; }
 185
 186     // This is called from the various OnInternalIdle methods
 187     bool GtkShowFromOnIdle();
 188
 189     // fix up the mouse event coords, used by wxListBox only so far
 190     virtual void FixUpMouseEvent(GtkWidget * WXUNUSED(widget),
 191                                  wxCoord& WXUNUSED(x),
 192                                  wxCoord& WXUNUSED(y)) { }
 193
 194     // is this window transparent for the mouse events (as wxStaticBox is)?
 195     virtual bool IsTransparentForMouse() const { return false; }
 196
 197     // is this a radiobutton (used by radiobutton code itself only)?
 198     virtual bool IsRadioButton() const { return false; }
 199
 200     // Common scroll event handling code for wxWindow and wxScrollBar
 201     wxEventType GetScrollEventType(GtkRange* range);
 202
 203     void BlockScrollEvent();
 204     void UnblockScrollEvent();
 205
 206     // position and size of the window
 207     int                  m_x, m_y;
 208     int                  m_width, m_height;
 209     int                  m_oldClientWidth,m_oldClientHeight;
 210
 211     // see the docs in src/gtk/window.cpp
 212     GtkWidget           *m_widget;          // mostly the widget seen by the rest of GTK
 213     GtkWidget           *m_wxwindow;        // mostly the client area as per wxWidgets
 214
 215     // this widget will be queried for GTK's focus events
 216     GtkWidget           *m_focusWidget;
 217
 218     wxGtkIMData         *m_imData;
 219
 220
 221     // indices for the arrays below
 222     enum ScrollDir { ScrollDir_Horz, ScrollDir_Vert, ScrollDir_Max };
 223
 224     // horizontal/vertical scroll bar
 225     GtkRange* m_scrollBar[ScrollDir_Max];
 226
 227     // horizontal/vertical scroll position
 228     double m_scrollPos[ScrollDir_Max];
 229
 230     // if true, don't notify about adjustment change (without resetting the
 231     // flag, so this has to be done manually)
 232     bool m_blockValueChanged[ScrollDir_Max];
 233
 234     // return the scroll direction index corresponding to the given orientation
 235     // (which is wxVERTICAL or wxHORIZONTAL)
 236     static ScrollDir ScrollDirFromOrient(int orient)
 237     {
 238         return orient == wxVERTICAL ? ScrollDir_Vert : ScrollDir_Horz;
 239     }
 240
 241     // return the orientation for the given scrolling direction
 242     static int OrientFromScrollDir(ScrollDir dir)
 243     {
 244         return dir == ScrollDir_Horz ? wxHORIZONTAL : wxVERTICAL;
 245     }
 246
 247     // find the direction of the given scrollbar (must be one of ours)
 248     ScrollDir ScrollDirFromRange(GtkRange *range) const;
 249
 250
 251     // extra (wxGTK-specific) flags
 252     bool                 m_needParent:1;        // ! wxFrame, wxDialog, wxNotebookPage ?
 253     bool                 m_noExpose:1;          // wxGLCanvas has its own redrawing
 254     bool                 m_nativeSizeEvent:1;   // wxGLCanvas sends wxSizeEvent upon "alloc_size"
 255     bool                 m_hasScrolling:1;
 256     bool                 m_hasVMT:1;
 257     bool                 m_sizeSet:1;
 258     bool                 m_resizing:1;
 259     bool                 m_acceptsFocus:1;      // true if not static
 260     bool                 m_hasFocus:1;          // true if == FindFocus()
 261     bool                 m_isScrolling:1;       // dragging scrollbar thumb?
 262     bool                 m_clipPaintRegion:1;   // true after ScrollWindow()
 263     bool                 m_dirtyTabOrder:1;     // tab order changed, GTK focus
 264                                                 // chain needs update
 265     bool                 m_needsStyleChange:1;  // May not be able to change
 266                                                 // background style until OnIdle
 267     bool                 m_mouseButtonDown:1;
 268     bool                 m_blockScrollEvent:1;
 269
 270     bool                 m_showOnIdle:1;        // postpone showing the window until idle
 271
 272     // C++ has no virtual methods in the constrcutor of any class but we need
 273     // different methods of inserting a child window into a wxFrame,
 274     // wxMDIFrame, wxNotebook etc. this is the callback that will get used.
 275     wxInsertChildFunction  m_insertCallback;
 276
 277 protected:
 278     // implement the base class pure virtuals
 279     virtual void DoClientToScreen( int *x, int *y ) const;
 280     virtual void DoScreenToClient( int *x, int *y ) const;
 281     virtual void DoGetPosition( int *x, int *y ) const;
 282     virtual void DoGetSize( int *width, int *height ) const;
 283     virtual void DoGetClientSize( int *width, int *height ) const;
 284     virtual void DoSetSize(int x, int y,
 285                            int width, int height,
 286                            int sizeFlags = wxSIZE_AUTO);
 287     virtual void DoSetClientSize(int width, int height);
 288     virtual void DoMoveWindow(int x, int y, int width, int height);
 289
 290 #if wxUSE_MENUS_NATIVE
 291     virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
 292 #endif // wxUSE_MENUS_NATIVE
 293
 294     virtual void DoCaptureMouse();
 295     virtual void DoReleaseMouse();
 296
 297 #if wxUSE_TOOLTIPS
 298     virtual void DoSetToolTip( wxToolTip *tip );
 299 #endif // wxUSE_TOOLTIPS
 300
 301     // common part of all ctors (not virtual because called from ctor)
 302     void Init();
 303
 304     virtual void DoMoveInTabOrder(wxWindow *win, MoveKind move);
 305
 306     // Copies m_children tab order to GTK focus chain:
 307     void RealizeTabOrder();
 308
 309     // Called by ApplyWidgetStyle (which is called by SetFont() and
 310     // SetXXXColour etc to apply style changed to native widgets) to create
 311     // modified GTK style with non-standard attributes. If forceStyle=true,
 312     // creates empty GtkRcStyle if there are no modifications, otherwise
 313     // returns NULL in such case.
 314     GtkRcStyle *CreateWidgetStyle(bool forceStyle = false);
 315
 316     // Overridden in many GTK widgets who have to handle subwidgets
 317     virtual void ApplyWidgetStyle(bool forceStyle = false);
 318
 319     // helper function to ease native widgets wrapping, called by
 320     // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
 321     virtual void DoApplyWidgetStyle(GtkRcStyle *style);
 322
 323     // sets the border of a given GtkScrolledWindow from a wx style
 324     static void GtkScrolledWindowSetBorder(GtkWidget* w, int style);
 325
 326 private:
 327     enum ScrollUnit { ScrollUnit_Line, ScrollUnit_Page, ScrollUnit_Max };
 328
 329     // common part of ScrollLines() and ScrollPages() and could be used, in the
 330     // future, for horizontal scrolling as well
 331     //
 332     // return true if we scrolled, false otherwise (on error or simply if we
 333     // are already at the end)
 334     bool DoScrollByUnits(ScrollDir dir, ScrollUnit unit, int units);
 335
 336
 337     DECLARE_DYNAMIC_CLASS(wxWindowGTK)
 338     DECLARE_NO_COPY_CLASS(wxWindowGTK)
 339 };
 340
 341 extern WXDLLIMPEXP_CORE wxWindow *wxFindFocusedChild(wxWindowGTK *win);
 342
 343 #endif // __GTKWINDOWH__