include/wx/gtk/window.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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 #ifdef __GNUG__
  15     #pragma interface
  16 #endif
  17
  18 //-----------------------------------------------------------------------------
  19 // callback definition for inserting a window (internal)
  20 //-----------------------------------------------------------------------------
  21
  22 typedef void (*wxInsertChildFunction)( wxWindow*, wxWindow* );
  23
  24 //-----------------------------------------------------------------------------
  25 // wxWindow
  26 //-----------------------------------------------------------------------------
  27
  28 class wxWindow : public wxWindowBase
  29 {
  30     DECLARE_DYNAMIC_CLASS(wxWindow)
  31
  32 public:
  33     // creating the window
  34     // -------------------
  35     wxWindow();
  36     wxWindow(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 ~wxWindow();
  49
  50     // implement base class (pure) virtual methods
  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     virtual void CaptureMouse();
  69     virtual void ReleaseMouse();
  70
  71     virtual void Refresh( bool eraseBackground = TRUE,
  72                           const wxRect *rect = (const wxRect *) NULL );
  73     virtual void Clear();
  74
  75     virtual bool SetBackgroundColour( const wxColour &colour );
  76     virtual bool SetForegroundColour( const wxColour &colour );
  77     virtual bool SetCursor( const wxCursor &cursor );
  78     virtual bool SetFont( const wxFont &font );
  79
  80     virtual int GetCharHeight() const;
  81     virtual int GetCharWidth() const;
  82     virtual void GetTextExtent(const wxString& string,
  83                                int *x, int *y,
  84                                int *descent = (int *) NULL,
  85                                int *externalLeading = (int *) NULL,
  86                                const wxFont *theFont = (const wxFont *) NULL)
  87                                const;
  88
  89     virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
  90
  91     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
  92                                int range, bool refresh = TRUE );
  93     virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE );
  94     virtual int GetScrollPos( int orient ) const;
  95     virtual int GetScrollThumb( int orient ) const;
  96     virtual int GetScrollRange( int orient ) const;
  97     virtual void ScrollWindow( int dx, int dy,
  98                                const wxRect* rect = (wxRect *) NULL );
  99
 100 #if wxUSE_DRAG_AND_DROP
 101     virtual void SetDropTarget( wxDropTarget *dropTarget );
 102 #endif // wxUSE_DRAG_AND_DROP
 103
 104     // implementation
 105     // --------------
 106
 107     virtual WXWidget GetHandle() const { return m_widget; }
 108
 109     /* I don't want users to override what's done in idle so everything that
 110        has to be done in idle time in order for wxGTK to work is done in
 111        OnInternalIdle */
 112     virtual void OnInternalIdle();
 113
 114     /* For compatibility across platforms (not in event table) */
 115     void OnIdle(wxIdleEvent& WXUNUSED(event)) {};
 116
 117     // wxGTK-specific: called recursively by Enable,
 118     // to give widgets an oppprtunity to correct their colours after they
 119     // have been changed by Enable
 120     virtual void OnParentEnable( bool WXUNUSED(enable) ) {};
 121
 122     /* used by all window classes in the widget creation process */
 123     bool PreCreation( wxWindow *parent, const wxPoint &pos, const wxSize &size );
 124     void PostCreation();
 125
 126     /* internal addition of child windows. differs from class
 127        to class not by using virtual functions but by using
 128        the m_insertCallback */
 129     void DoAddChild(wxWindow *child);
 130
 131     /* the methods below are required because many native widgets
 132        are composed of several subwidgets and setting a style for
 133        the widget means setting it for all subwidgets as well.
 134        also, it is nor clear, which native widget is the top
 135        widget where (most of) the input goes. even tooltips have
 136        to be applied to all subwidgets. */
 137
 138     virtual GtkWidget* GetConnectWidget();
 139     virtual bool IsOwnGtkWindow( GdkWindow *window );
 140     void ConnectWidget( GtkWidget *widget );
 141
 142     /* creates a new widget style if none is there
 143        and sets m_widgetStyle to this value. */
 144     GtkStyle *GetWidgetStyle();
 145
 146     /* called by SetFont() and SetXXXColour etc */
 147     void SetWidgetStyle();
 148
 149     /* overridden in many GTK widgets */
 150     virtual void ApplyWidgetStyle();
 151
 152 #if wxUSE_TOOLTIPS
 153     virtual void ApplyToolTip( GtkTooltips *tips, const wxChar *tip );
 154 #endif // wxUSE_TOOLTIPS
 155
 156     // called from GTK signales handlers. it indicates that
 157     // the layouting functions have to be called later on
 158     // (i.e. in idle time, implemented in OnInternalIdle() ).
 159     void GtkUpdateSize() { m_sizeSet = FALSE; }
 160
 161     // position and size of the window
 162     int                  m_x, m_y;
 163     int                  m_width, m_height;
 164     int                  m_oldClientWidth,m_oldClientHeight;
 165
 166     /* see the docs in src/gtk/window.cpp */
 167     GtkWidget           *m_widget;
 168     GtkWidget           *m_wxwindow;
 169
 170 #if HAVE_XIM
 171     /* XIM support for wxWindows */
 172     GdkIC               *m_ic;
 173     GdkICAttr           *m_icattr;
 174 #endif
 175
 176     /* scrolling stuff */
 177     GtkAdjustment       *m_hAdjust,*m_vAdjust;
 178     float                m_oldHorizontalPos;
 179     float                m_oldVerticalPos;
 180
 181     // extra (wxGTK-specific) flags
 182     bool                 m_needParent:1;        /* ! wxFrame, wxDialog, wxNotebookPage ?  */
 183     bool                 m_noExpose:1;          /* wxGLCanvas has its own redrawing */
 184     bool                 m_nativeSizeEvent:1;   /* wxGLCanvas sends wxSizeEvent upon "alloc_size" */
 185     bool                 m_hasScrolling:1;
 186     bool                 m_hasVMT:1;
 187     bool                 m_sizeSet:1;
 188     bool                 m_resizing:1;
 189     bool                 m_isStaticBox:1;    /* faster than IS_KIND_OF */
 190     bool                 m_isRadioButton:1;  /* faster than IS_KIND_OF */
 191     bool                 m_isFrame:1;        /* faster than IS_KIND_OF */
 192     bool                 m_acceptsFocus:1;   /* not wxStaticBox, not wxStaticBitmap etc.  */
 193     bool                 m_isScrolling;
 194     bool                 m_clipPaintRegion;  /* TRUE after ScrollWindow() */
 195     bool                 m_queuedFullRedraw; /* TRUE after DoMoveWindow */
 196
 197     // these are true if the style were set before the widget was realized
 198     // (typcally in the constructor) but the actual GTK style must not be set
 199     // before the widget has been "realized"
 200     bool                 m_delayedForegroundColour:1;
 201     bool                 m_delayedBackgroundColour:1;
 202
 203     // contains GTK's widgets internal information about non-default widget
 204     // font and colours. we create one for each widget that gets any
 205     // non-default attribute set via SetFont() or SetForegroundColour() /
 206     // SetBackgroundColour().
 207     GtkStyle            *m_widgetStyle;
 208
 209     // C++ has no virtual methods in the constrcutor of any class but we need
 210     // different methods of inserting a child window into a wxFrame,
 211     // wxMDIFrame, wxNotebook etc. this is the callback that will get used.
 212     wxInsertChildFunction  m_insertCallback;
 213
 214     // implement the base class pure virtuals
 215     virtual void DoClientToScreen( int *x, int *y ) const;
 216     virtual void DoScreenToClient( int *x, int *y ) const;
 217     virtual void DoGetPosition( int *x, int *y ) const;
 218     virtual void DoGetSize( int *width, int *height ) const;
 219     virtual void DoGetClientSize( int *width, int *height ) const;
 220     virtual void DoSetSize(int x, int y,
 221                            int width, int height,
 222                            int sizeFlags = wxSIZE_AUTO);
 223     virtual void DoSetClientSize(int width, int height);
 224     virtual void DoMoveWindow(int x, int y, int width, int height);
 225
 226 #if wxUSE_TOOLTIPS
 227     virtual void DoSetToolTip( wxToolTip *tip );
 228 #endif // wxUSE_TOOLTIPS
 229
 230     // common part of all ctors (can't be virtual because called from ctor)
 231     void Init();
 232
 233 private:
 234     DECLARE_NO_COPY_CLASS(wxWindow);
 235 };
 236
 237 #endif // __GTKWINDOWH__