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 &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 #if wxUSE_MENUS_NATIVE
  95     virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
  96 #endif // wxUSE_MENUS_NATIVE
  97
  98     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
  99                                int range, 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 #if wxUSE_DRAG_AND_DROP
 108     virtual void SetDropTarget( wxDropTarget *dropTarget );
 109 #endif // wxUSE_DRAG_AND_DROP
 110
 111 #ifdef __WXGTK20__
 112     virtual void AddChild( wxWindowBase *child );
 113     virtual void RemoveChild( wxWindowBase *child );
 114 #endif
 115
 116     // implementation
 117     // --------------
 118
 119     virtual WXWidget GetHandle() const { return m_widget; }
 120
 121     // I don't want users to override what's done in idle so everything that
 122     // has to be done in idle time in order for wxGTK to work is done in
 123     // OnInternalIdle
 124     virtual void OnInternalIdle();
 125
 126     // Internal represention of Update()
 127     void GtkUpdate();
 128
 129     // For compatibility across platforms (not in event table)
 130     void OnIdle(wxIdleEvent& WXUNUSED(event)) {}
 131
 132     // wxGTK-specific: called recursively by Enable,
 133     // to give widgets an opportunity to correct their colours after they
 134     // have been changed by Enable
 135     virtual void OnParentEnable( bool WXUNUSED(enable) ) {}
 136
 137     // Used by all window classes in the widget creation process.
 138     bool PreCreation( wxWindowGTK *parent, const wxPoint &pos, const wxSize &size );
 139     void PostCreation();
 140
 141     // Internal addition of child windows. differs from class
 142     // to class not by using virtual functions but by using
 143     // the m_insertCallback.
 144     void DoAddChild(wxWindowGTK *child);
 145
 146     // This methods sends wxPaintEvents to the window. It reads the
 147     // update region, breaks it up into rects and sends an event
 148     // for each rect. It is also responsible for background erase
 149     // events and NC paint events. It is called from "draw" and
 150     // "expose" handlers as well as from ::Update()
 151     void GtkSendPaintEvents();
 152
 153     // The methods below are required because many native widgets
 154     // are composed of several subwidgets and setting a style for
 155     // the widget means setting it for all subwidgets as well.
 156     // also, it is not clear which native widget is the top
 157     // widget where (most of) the input goes. even tooltips have
 158     // to be applied to all subwidgets.
 159     virtual GtkWidget* GetConnectWidget();
 160     virtual bool IsOwnGtkWindow( GdkWindow *window );
 161     void ConnectWidget( GtkWidget *widget );
 162
 163 #ifdef __WXGTK20__
 164     // Returns the default context which usually is anti-aliased
 165     PangoContext   *GtkGetPangoDefaultContext();
 166
 167     // Returns the X11 context which renders on the X11 client
 168     // side (which can be remote) and which usually is not
 169     // anti-aliased and is thus faster
 170     // MR: Now returns the default pango_context for the widget as GtkGetPangoDefaultContext to
 171     // not depend on libpangox - which is completely deprecated.
 172     //BCI: Remove GtkGetPangoX11Context and m_x11Context completely when symbols may be removed
 173     PangoContext   *GtkGetPangoX11Context();
 174     PangoContext   *m_x11Context; // MR: Now unused
 175 #endif
 176
 177 #if wxUSE_TOOLTIPS
 178     virtual void ApplyToolTip( GtkTooltips *tips, const wxChar *tip );
 179 #endif // wxUSE_TOOLTIPS
 180
 181     // Call after modifing the value of m_hAdjust or m_vAdjust to bring the
 182     // scrolbar in sync (this does not generate any wx events)
 183     void GtkUpdateScrollbar(int orient);
 184
 185     // Called from GTK signal handlers. it indicates that
 186     // the layouting functions have to be called later on
 187     // (i.e. in idle time, implemented in OnInternalIdle() ).
 188     void GtkUpdateSize() { m_sizeSet = false; }
 189
 190     // fix up the mouse event coords, used by wxListBox only so far
 191     virtual void FixUpMouseEvent(GtkWidget * WXUNUSED(widget),
 192                                  wxCoord& WXUNUSED(x),
 193                                  wxCoord& WXUNUSED(y)) { }
 194
 195     // is this window transparent for the mouse events (as wxStaticBox is)?
 196     virtual bool IsTransparentForMouse() const { return false; }
 197
 198     // is this a radiobutton (used by radiobutton code itself only)?
 199     virtual bool IsRadioButton() const { return false; }
 200
 201     // position and size of the window
 202     int                  m_x, m_y;
 203     int                  m_width, m_height;
 204     int                  m_oldClientWidth,m_oldClientHeight;
 205
 206     // see the docs in src/gtk/window.cpp
 207     GtkWidget           *m_widget;          // mostly the widget seen by the rest of GTK
 208     GtkWidget           *m_wxwindow;        // mostly the client area as per wxWidgets
 209
 210     // this widget will be queried for GTK's focus events
 211     GtkWidget           *m_focusWidget;
 212
 213 #ifdef __WXGTK20__
 214     wxGtkIMData         *m_imData;
 215 #else // GTK 1
 216 #ifdef HAVE_XIM
 217     // XIM support for wxWidgets
 218     GdkIC               *m_ic;
 219     GdkICAttr           *m_icattr;
 220 #endif // HAVE_XIM
 221 #endif // GTK 2/1
 222
 223 #ifndef __WXGTK20__
 224     // The area to be cleared (and not just refreshed)
 225     // We cannot make this distinction under GTK 2.0.
 226     wxRegion             m_clearRegion;
 227 #endif
 228
 229     // scrolling stuff
 230     GtkAdjustment       *m_hAdjust,*m_vAdjust;
 231     float                m_oldHorizontalPos;
 232     float                m_oldVerticalPos;
 233
 234     // extra (wxGTK-specific) flags
 235     bool                 m_needParent:1;        // ! wxFrame, wxDialog, wxNotebookPage ?
 236     bool                 m_noExpose:1;          // wxGLCanvas has its own redrawing
 237     bool                 m_nativeSizeEvent:1;   // wxGLCanvas sends wxSizeEvent upon "alloc_size"
 238     bool                 m_hasScrolling:1;
 239     bool                 m_hasVMT:1;
 240     bool                 m_sizeSet:1;
 241     bool                 m_resizing:1;
 242     bool                 m_acceptsFocus:1;      // true if not static
 243     bool                 m_hasFocus:1;          // true if == FindFocus()
 244     bool                 m_isScrolling:1;       // dragging scrollbar thumb?
 245     bool                 m_clipPaintRegion:1;   // true after ScrollWindow()
 246 #ifdef __WXGTK20__
 247     bool                 m_dirtyTabOrder:1;     // tab order changed, GTK focus
 248                                                 // chain needs update
 249 #endif
 250     bool                 m_needsStyleChange:1;  // May not be able to change
 251                                                 // background style until OnIdle
 252
 253     // C++ has no virtual methods in the constrcutor of any class but we need
 254     // different methods of inserting a child window into a wxFrame,
 255     // wxMDIFrame, wxNotebook etc. this is the callback that will get used.
 256     wxInsertChildFunction  m_insertCallback;
 257
 258     // implement the base class pure virtuals
 259     virtual void DoClientToScreen( int *x, int *y ) const;
 260     virtual void DoScreenToClient( int *x, int *y ) const;
 261     virtual void DoGetPosition( int *x, int *y ) const;
 262     virtual void DoGetSize( int *width, int *height ) const;
 263     virtual void DoGetClientSize( int *width, int *height ) const;
 264     virtual void DoSetSize(int x, int y,
 265                            int width, int height,
 266                            int sizeFlags = wxSIZE_AUTO);
 267     virtual void DoSetClientSize(int width, int height);
 268     virtual void DoMoveWindow(int x, int y, int width, int height);
 269
 270     virtual void DoCaptureMouse();
 271     virtual void DoReleaseMouse();
 272
 273 #if wxUSE_TOOLTIPS
 274     virtual void DoSetToolTip( wxToolTip *tip );
 275 #endif // wxUSE_TOOLTIPS
 276
 277 protected:
 278     // common part of all ctors (not virtual because called from ctor)
 279     void Init();
 280
 281 #ifdef __WXGTK20__
 282     virtual void DoMoveInTabOrder(wxWindow *win, MoveKind move);
 283
 284     // Copies m_children tab order to GTK focus chain:
 285     void RealizeTabOrder();
 286 #endif
 287
 288     // Called by ApplyWidgetStyle (which is called by SetFont() and
 289     // SetXXXColour etc to apply style changed to native widgets) to create
 290     // modified GTK style with non-standard attributes. If forceStyle=true,
 291     // creates empty GtkRcStyle if there are no modifications, otherwise
 292     // returns NULL in such case.
 293     GtkRcStyle *CreateWidgetStyle(bool forceStyle = false);
 294
 295     // Overridden in many GTK widgets who have to handle subwidgets
 296     virtual void ApplyWidgetStyle(bool forceStyle = false);
 297
 298     // helper function to ease native widgets wrapping, called by
 299     // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
 300     virtual void DoApplyWidgetStyle(GtkRcStyle *style);
 301
 302 private:
 303     DECLARE_DYNAMIC_CLASS(wxWindowGTK)
 304     DECLARE_NO_COPY_CLASS(wxWindowGTK)
 305 };
 306
 307 extern WXDLLIMPEXP_CORE wxWindow *wxFindFocusedChild(wxWindowGTK *win);
 308
 309 #endif // __GTKWINDOWH__