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
  11 #ifndef __GTKWINDOWH__
  12 #define __GTKWINDOWH__
  13
  14 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  15     #pragma interface
  16 #endif
  17
  18 //-----------------------------------------------------------------------------
  19 // callback definition for inserting a window (internal)
  20 //-----------------------------------------------------------------------------
  21
  22 class wxWindowGTK;
  23 typedef void (*wxInsertChildFunction)( wxWindowGTK*, wxWindowGTK* );
  24
  25 //-----------------------------------------------------------------------------
  26 // wxWindowGTK
  27 //-----------------------------------------------------------------------------
  28
  29 class wxWindowGTK : public wxWindowBase
  30 {
  31 public:
  32     // creating the window
  33     // -------------------
  34     wxWindowGTK();
  35     wxWindowGTK(wxWindow *parent,
  36                 wxWindowID id,
  37                 const wxPoint& pos = wxDefaultPosition,
  38                 const wxSize& size = wxDefaultSize,
  39                 long style = 0,
  40                 const wxString& name = wxPanelNameStr);
  41     bool Create(wxWindow *parent,
  42                 wxWindowID id,
  43                 const wxPoint& pos = wxDefaultPosition,
  44                 const wxSize& size = wxDefaultSize,
  45                 long style = 0,
  46                 const wxString& name = wxPanelNameStr);
  47     virtual ~wxWindowGTK();
  48
  49     // implement base class (pure) virtual methods
  50     // -------------------------------------------
  51
  52     virtual bool Destroy();
  53
  54     virtual void Raise();
  55     virtual void Lower();
  56
  57     virtual bool Show( bool show = TRUE );
  58     virtual bool Enable( bool enable = TRUE );
  59
  60     virtual bool IsRetained() const;
  61
  62     virtual void SetFocus();
  63     virtual bool AcceptsFocus() const;
  64
  65     virtual bool Reparent( wxWindowBase *newParent );
  66
  67     virtual void WarpPointer(int x, int y);
  68
  69     virtual void Refresh( bool eraseBackground = TRUE,
  70                           const wxRect *rect = (const wxRect *) NULL );
  71     virtual void Update();
  72     virtual void ClearBackground();
  73
  74     virtual bool SetBackgroundColour( const wxColour &colour );
  75     virtual bool SetForegroundColour( const wxColour &colour );
  76     virtual bool SetCursor( const wxCursor &cursor );
  77     virtual bool SetFont( const wxFont &font );
  78
  79     virtual int GetCharHeight() const;
  80     virtual int GetCharWidth() const;
  81     virtual void GetTextExtent(const wxString& string,
  82                                int *x, int *y,
  83                                int *descent = (int *) NULL,
  84                                int *externalLeading = (int *) NULL,
  85                                const wxFont *theFont = (const wxFont *) NULL)
  86                                const;
  87
  88 #if wxUSE_MENUS_NATIVE
  89     virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
  90 #endif // wxUSE_MENUS_NATIVE
  91
  92     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
  93                                int range, bool refresh = TRUE );
  94     virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE );
  95     virtual int GetScrollPos( int orient ) const;
  96     virtual int GetScrollThumb( int orient ) const;
  97     virtual int GetScrollRange( int orient ) const;
  98     virtual void ScrollWindow( int dx, int dy,
  99                                const wxRect* rect = (wxRect *) NULL );
 100
 101 #if wxUSE_DRAG_AND_DROP
 102     virtual void SetDropTarget( wxDropTarget *dropTarget );
 103 #endif // wxUSE_DRAG_AND_DROP
 104
 105     // implementation
 106     // --------------
 107
 108     virtual WXWidget GetHandle() const { return m_widget; }
 109
 110     // I don't want users to override what's done in idle so everything that
 111     // has to be done in idle time in order for wxGTK to work is done in
 112     // OnInternalIdle
 113     virtual void OnInternalIdle();
 114
 115     // Internal represention of Update()
 116     void GtkUpdate();
 117
 118     // For compatibility across platforms (not in event table)
 119     void OnIdle(wxIdleEvent& WXUNUSED(event)) {}
 120
 121     // wxGTK-specific: called recursively by Enable,
 122     // to give widgets an oppprtunity to correct their colours after they
 123     // have been changed by Enable
 124     virtual void OnParentEnable( bool WXUNUSED(enable) ) {}
 125
 126     // Used by all window classes in the widget creation process.
 127     bool PreCreation( wxWindowGTK *parent, const wxPoint &pos, const wxSize &size );
 128     void PostCreation();
 129
 130     // Internal addition of child windows. differs from class
 131     // to class not by using virtual functions but by using
 132     // the m_insertCallback.
 133     void DoAddChild(wxWindowGTK *child);
 134
 135     // This methods sends wxPaintEvents to the window. It reads the
 136     // update region, breaks it up into rects and sends an event
 137     // for each rect. It is also responsible for background erase
 138     // events and NC paint events. It is called from "draw" and
 139     // "expose" handlers as well as from ::Update()
 140     void GtkSendPaintEvents();
 141
 142     // The methods below are required because many native widgets
 143     // are composed of several subwidgets and setting a style for
 144     // the widget means setting it for all subwidgets as well.
 145     // also, it is nor clear, which native widget is the top
 146     // widget where (most of) the input goes. even tooltips have
 147     // to be applied to all subwidgets.
 148     virtual GtkWidget* GetConnectWidget();
 149     virtual bool IsOwnGtkWindow( GdkWindow *window );
 150     void ConnectWidget( GtkWidget *widget );
 151
 152 #ifdef __WXGTK20__
 153     // Returns the default context which usually is anti-aliased
 154     PangoContext   *GtkGetPangoDefaultContext();
 155
 156     // Returns the X11 context which renders on the X11 client
 157     // side (which can be remote) and which usually is not
 158     // anti-aliased and is thus faster
 159     PangoContext   *GtkGetPangoX11Context();
 160     PangoContext   *m_x11Context;
 161 #endif
 162
 163 #if wxUSE_TOOLTIPS
 164     virtual void ApplyToolTip( GtkTooltips *tips, const wxChar *tip );
 165 #endif // wxUSE_TOOLTIPS
 166
 167     // Called from GTK signales handlers. it indicates that
 168     // the layouting functions have to be called later on
 169     // (i.e. in idle time, implemented in OnInternalIdle() ).
 170     void GtkUpdateSize() { m_sizeSet = FALSE; }
 171
 172     // fix up the mouse event coords, used by wxListBox only so far
 173     virtual void FixUpMouseEvent(GtkWidget * WXUNUSED(widget),
 174                                  wxCoord& WXUNUSED(x),
 175                                  wxCoord& WXUNUSED(y)) { }
 176
 177     // is this window transparent for the mouse events (as wxStaticBox is)?
 178     virtual bool IsTransparentForMouse() const { return FALSE; }
 179
 180     // is this a radiobutton (used by radiobutton code itself only)?
 181     virtual bool IsRadioButton() const { return FALSE; }
 182
 183     // position and size of the window
 184     int                  m_x, m_y;
 185     int                  m_width, m_height;
 186     int                  m_oldClientWidth,m_oldClientHeight;
 187
 188     // see the docs in src/gtk/window.cpp
 189     GtkWidget           *m_widget;          // mostly the widget seen by the rest of GTK
 190     GtkWidget           *m_wxwindow;        // mostly the client area as per wxWidgets
 191
 192     // this widget will be queried for GTK's focus events
 193     GtkWidget           *m_focusWidget;
 194
 195 #ifdef __WXGTK20__
 196     GtkIMMulticontext   *m_imContext;
 197 #else
 198 #if HAVE_XIM
 199     // XIM support for wxWidgets
 200     GdkIC               *m_ic;
 201     GdkICAttr           *m_icattr;
 202 #endif
 203 #endif
 204
 205 #ifndef __WXGTK20__
 206     // The area to be cleared (and not just refreshed)
 207     // We cannot make this distinction under GTK 2.0.
 208     wxRegion             m_clearRegion;
 209 #endif
 210
 211     // scrolling stuff
 212     GtkAdjustment       *m_hAdjust,*m_vAdjust;
 213     float                m_oldHorizontalPos;
 214     float                m_oldVerticalPos;
 215
 216     // extra (wxGTK-specific) flags
 217     bool                 m_needParent:1;        // ! wxFrame, wxDialog, wxNotebookPage ?
 218     bool                 m_noExpose:1;          // wxGLCanvas has its own redrawing
 219     bool                 m_nativeSizeEvent:1;   // wxGLCanvas sends wxSizeEvent upon "alloc_size"
 220     bool                 m_hasScrolling:1;
 221     bool                 m_hasVMT:1;
 222     bool                 m_sizeSet:1;
 223     bool                 m_resizing:1;
 224     bool                 m_acceptsFocus:1;      // true if not static
 225     bool                 m_hasFocus:1;          // true if == FindFocus()
 226     bool                 m_isScrolling:1;       // dragging scrollbar thumb?
 227     bool                 m_clipPaintRegion:1;   // TRUE after ScrollWindow()
 228     bool                 m_queuedFullRedraw:1;  // TRUE after DoMoveWindow
 229
 230     // C++ has no virtual methods in the constrcutor of any class but we need
 231     // different methods of inserting a child window into a wxFrame,
 232     // wxMDIFrame, wxNotebook etc. this is the callback that will get used.
 233     wxInsertChildFunction  m_insertCallback;
 234
 235     // implement the base class pure virtuals
 236     virtual void DoClientToScreen( int *x, int *y ) const;
 237     virtual void DoScreenToClient( int *x, int *y ) const;
 238     virtual void DoGetPosition( int *x, int *y ) const;
 239     virtual void DoGetSize( int *width, int *height ) const;
 240     virtual void DoGetClientSize( int *width, int *height ) const;
 241     virtual void DoSetSize(int x, int y,
 242                            int width, int height,
 243                            int sizeFlags = wxSIZE_AUTO);
 244     virtual void DoSetClientSize(int width, int height);
 245     virtual void DoMoveWindow(int x, int y, int width, int height);
 246
 247     virtual void DoCaptureMouse();
 248     virtual void DoReleaseMouse();
 249
 250 #if wxUSE_TOOLTIPS
 251     virtual void DoSetToolTip( wxToolTip *tip );
 252 #endif // wxUSE_TOOLTIPS
 253
 254 protected:
 255     // common part of all ctors (not virtual because called from ctor)
 256     void Init();
 257
 258     // Called by ApplyWidgetStyle (which is called by SetFont() and
 259     // SetXXXColour etc to apply style changed to native widgets) to create
 260     // modified GTK style with non-standard attributes. If forceStyle=true,
 261     // creates empty GtkRcStyle if there are no modifications, otherwise
 262     // returns NULL in such case.
 263     GtkRcStyle *CreateWidgetStyle(bool forceStyle = false);
 264
 265     // Overridden in many GTK widgets who have to handle subwidgets
 266     virtual void ApplyWidgetStyle(bool forceStyle = false);
 267
 268     // helper function to ease native widgets wrapping, called by
 269     // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
 270     virtual void DoApplyWidgetStyle(GtkRcStyle *style);
 271
 272 private:
 273     DECLARE_DYNAMIC_CLASS(wxWindowGTK)
 274     DECLARE_NO_COPY_CLASS(wxWindowGTK)
 275 };
 276
 277 extern wxWindow *wxFindFocusedChild(wxWindowGTK *win);
 278
 279 #endif // __GTKWINDOWH__