include/wx/gtk1/window.h

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