]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/gtk1/window.h
enum wxWebViewBackend has been removed.
[wxWidgets.git] / include / wx / gtk1 / window.h
index 18f6a1abc0494cffe2aebba0d58d964f6f11b4d8..388f06fd91cc210b90fafe933c7eb6248fac1a70 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        window.h
+// Name:        wx/gtk1/window.h
 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$
@@ -7,55 +7,65 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-
 #ifndef __GTKWINDOWH__
 #define __GTKWINDOWH__
 
-#ifdef __GNUG__
-    #pragma interface
+typedef struct _GtkTooltips GtkTooltips;
+#ifdef HAVE_XIM
+typedef struct _GdkIC GdkIC;
+typedef struct _GdkICAttr GdkICAttr;
 #endif
 
+// helper structure that holds class that holds GtkIMContext object and
+// some additional data needed for key events processing
+struct wxGtkIMData;
+
 //-----------------------------------------------------------------------------
 // callback definition for inserting a window (internal)
 //-----------------------------------------------------------------------------
 
-typedef void (*wxInsertChildFunction)( wxWindow*, wxWindow* );
+class WXDLLIMPEXP_FWD_CORE wxWindowGTK;
+typedef void (*wxInsertChildFunction)( wxWindowGTK*, wxWindowGTK* );
 
 //-----------------------------------------------------------------------------
-// wxWindow
+// wxWindowGTK
 //-----------------------------------------------------------------------------
 
-class wxWindow : public wxWindowBase
+class WXDLLIMPEXP_CORE wxWindowGTK : public wxWindowBase
 {
-    DECLARE_DYNAMIC_CLASS(wxWindow)
-
 public:
     // creating the window
     // -------------------
-    wxWindow();
-    wxWindow(wxWindow *parent,
-             wxWindowID id,
-             const wxPoint& pos = wxDefaultPosition,
-             const wxSize& size = wxDefaultSize,
-             long style = 0,
-             const wxString& name = wxPanelNameStr);
+    wxWindowGTK();
+    wxWindowGTK(wxWindow *parent,
+                wxWindowID id,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = 0,
+                const wxString& name = wxPanelNameStr);
     bool Create(wxWindow *parent,
                 wxWindowID id,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = 0,
                 const wxString& name = wxPanelNameStr);
-    virtual ~wxWindow();
+    virtual ~wxWindowGTK();
 
     // implement base class (pure) virtual methods
     // -------------------------------------------
+
+    virtual void SetLabel(const wxString& WXUNUSED(label)) { }
+    virtual wxString GetLabel() const { return wxEmptyString; }
+
     virtual bool Destroy();
 
     virtual void Raise();
     virtual void Lower();
 
-    virtual bool Show( bool show = TRUE );
-    virtual bool Enable( bool enable = TRUE );
+    virtual bool Show( bool show = true );
+    virtual void DoEnable( bool enable );
+
+    virtual void SetWindowStyleFlag( long style );
 
     virtual bool IsRetained() const;
 
@@ -65,145 +75,146 @@ public:
     virtual bool Reparent( wxWindowBase *newParent );
 
     virtual void WarpPointer(int x, int y);
-    virtual void CaptureMouse();
-    virtual void ReleaseMouse();
 
-    virtual void Refresh( bool eraseBackground = TRUE,
+    virtual void Refresh( bool eraseBackground = true,
                           const wxRect *rect = (const wxRect *) NULL );
-    virtual void Clear();
+    virtual void Update();
+    virtual void ClearBackground();
 
     virtual bool SetBackgroundColour( const wxColour &colour );
     virtual bool SetForegroundColour( const wxColour &colour );
     virtual bool SetCursor( const wxCursor &cursor );
     virtual bool SetFont( const wxFont &font );
 
+    virtual bool SetBackgroundStyle(wxBackgroundStyle style) ;
+
     virtual int GetCharHeight() const;
     virtual int GetCharWidth() const;
-    virtual void GetTextExtent(const wxString& string,
-                               int *x, int *y,
-                               int *descent = (int *) NULL,
-                               int *externalLeading = (int *) NULL,
-                               const wxFont *theFont = (const wxFont *) NULL)
-                               const;
-
-    virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
 
     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
-                               int range, bool refresh = TRUE );
-    virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE );
+                               int range, bool refresh = true );
+    virtual void SetScrollPos( int orient, int pos, bool refresh = true );
     virtual int GetScrollPos( int orient ) const;
     virtual int GetScrollThumb( int orient ) const;
     virtual int GetScrollRange( int orient ) const;
     virtual void ScrollWindow( int dx, int dy,
-                               const wxRect* rect = (wxRect *) NULL );
+                               const wxRect* rect = NULL );
 
 #if wxUSE_DRAG_AND_DROP
     virtual void SetDropTarget( wxDropTarget *dropTarget );
 #endif // wxUSE_DRAG_AND_DROP
 
+    virtual bool IsDoubleBuffered() const { return false; }
+
+    GdkWindow* GTKGetDrawingWindow() const;
+
     // implementation
     // --------------
 
     virtual WXWidget GetHandle() const { return m_widget; }
 
-    // also sets the global flag
-    void SetScrolling(bool scroll);
-
-    bool HasScrolling() const { return m_hasScrolling; }
-    bool IsScrolling() const { return m_isScrolling; }
-
-    /* I don't want users to override what's done in idle so everything that
-       has to be done in idle time in order for wxGTK to work is done in
-       OnInternalIdle */
+    // I don't want users to override what's done in idle so everything that
+    // has to be done in idle time in order for wxGTK to work is done in
+    // OnInternalIdle
     virtual void OnInternalIdle();
 
-    /* For compatibility across platforms (not in event table) */
-    void OnIdle(wxIdleEvent& WXUNUSED(event)) {};
-
-    /* used by all window classes in the widget creation process */
-    bool PreCreation( wxWindow *parent, const wxPoint &pos, const wxSize &size );
-    void PostCreation();
+    // Internal representation of Update()
+    void GtkUpdate();
 
-    /* internal addition of child windows. differs from class
-       to class not by using virtual functions but by using
-       the m_insertCallback */
-    void DoAddChild(wxWindow *child);
+    // For compatibility across platforms (not in event table)
+    void OnIdle(wxIdleEvent& WXUNUSED(event)) {}
 
-    /* the methods below are required because many native widgets
-       are composed of several subwidgets and setting a style for
-       the widget means setting it for all subwidgets as well.
-       also, it is nor clear, which native widget is the top
-       widget where (most of) the input goes. even tooltips have
-       to be applied to all subwidgets. */
+    // Used by all window classes in the widget creation process.
+    bool PreCreation( wxWindowGTK *parent, const wxPoint &pos, const wxSize &size );
+    void PostCreation();
 
+    // Internal addition of child windows. differs from class
+    // to class not by using virtual functions but by using
+    // the m_insertCallback.
+    void DoAddChild(wxWindowGTK *child);
+
+    // This methods sends wxPaintEvents to the window. It reads the
+    // update region, breaks it up into rects and sends an event
+    // for each rect. It is also responsible for background erase
+    // events and NC paint events. It is called from "draw" and
+    // "expose" handlers as well as from ::Update()
+    void GtkSendPaintEvents();
+
+    // The methods below are required because many native widgets
+    // are composed of several subwidgets and setting a style for
+    // the widget means setting it for all subwidgets as well.
+    // also, it is not clear which native widget is the top
+    // widget where (most of) the input goes. even tooltips have
+    // to be applied to all subwidgets.
     virtual GtkWidget* GetConnectWidget();
     virtual bool IsOwnGtkWindow( GdkWindow *window );
     void ConnectWidget( GtkWidget *widget );
 
-    /* creates a new widget style if none is there
-       and sets m_widgetStyle to this value. */
-    GtkStyle *GetWidgetStyle();
-
-    /* called by SetFont() and SetXXXColour etc */
-    void SetWidgetStyle();
-
-    /* overridden in many GTK widgets */
-    virtual void ApplyWidgetStyle();
-
 #if wxUSE_TOOLTIPS
     virtual void ApplyToolTip( GtkTooltips *tips, const wxChar *tip );
 #endif // wxUSE_TOOLTIPS
 
-    // called from GTK signales handlers. it indicates that
-    // the layouting functions have to be called later on
+    // Call after modifing the value of m_hAdjust or m_vAdjust to bring the
+    // scrolbar in sync (this does not generate any wx events)
+    void GtkUpdateScrollbar(int orient);
+
+    // Called from GTK signal handlers. it indicates that
+    // the layout functions have to be called later on
     // (i.e. in idle time, implemented in OnInternalIdle() ).
-    void UpdateSize() { m_sizeSet = FALSE; }
+    void GtkUpdateSize() { m_sizeSet = false; }
+
+    // fix up the mouse event coords, used by wxListBox only so far
+    virtual void FixUpMouseEvent(GtkWidget * WXUNUSED(widget),
+                                 wxCoord& WXUNUSED(x),
+                                 wxCoord& WXUNUSED(y)) { }
+
+    // is this window transparent for the mouse events (as wxStaticBox is)?
+    virtual bool IsTransparentForMouse() const { return false; }
+
+    // is this a radiobutton (used by radiobutton code itself only)?
+    virtual bool IsRadioButton() const { return false; }
 
     // position and size of the window
     int                  m_x, m_y;
     int                  m_width, m_height;
+    int                  m_oldClientWidth,m_oldClientHeight;
+
+    // see the docs in src/gtk/window.cpp
+    GtkWidget           *m_widget;          // mostly the widget seen by the rest of GTK
+    GtkWidget           *m_wxwindow;        // mostly the client area as per wxWidgets
 
-    /* see the docs in src/gtk/window.cpp */
-    GtkWidget           *m_widget;
-    GtkWidget           *m_wxwindow;
+    // this widget will be queried for GTK's focus events
+    GtkWidget           *m_focusWidget;
 
-#if HAVE_XIM
-    /* XIM support for wxWindows */
+#ifdef HAVE_XIM
+    // XIM support for wxWidgets
     GdkIC               *m_ic;
     GdkICAttr           *m_icattr;
-#endif
-    
-    /* scrolling stuff */
+#endif // HAVE_XIM
+
+    // The area to be cleared (and not just refreshed)
+    // We cannot make this distinction under GTK 2.0.
+    wxRegion             m_clearRegion;
+
+    // scrolling stuff
     GtkAdjustment       *m_hAdjust,*m_vAdjust;
     float                m_oldHorizontalPos;
     float                m_oldVerticalPos;
 
     // extra (wxGTK-specific) flags
-    bool                 m_needParent:1;        /* ! wxFrame, wxDialog, wxNotebookPage ?  */
-    bool                 m_noExpose:1;          /* wxGLCanvas has its own redrawing */
-    bool                 m_nativeSizeEvent:1;   /* wxGLCanvas sends wxSizeEvent upon "alloc_size" */
+    bool                 m_needParent:1;        // ! wxFrame, wxDialog, wxNotebookPage ?
+    bool                 m_noExpose:1;          // wxGLCanvas has its own redrawing
+    bool                 m_nativeSizeEvent:1;   // wxGLCanvas sends wxSizeEvent upon "alloc_size"
     bool                 m_hasScrolling:1;
-    bool                 m_isScrolling:1;
     bool                 m_hasVMT:1;
     bool                 m_sizeSet:1;
     bool                 m_resizing:1;
-    bool                 m_isStaticBox:1;    /* faster than IS_KIND_OF */
-    bool                 m_isRadioButton:1;  /* faster than IS_KIND_OF */
-    bool                 m_isFrame:1;        /* faster than IS_KIND_OF */
-    bool                 m_acceptsFocus:1;   /* not wxStaticBox, not wxStaticBitmap etc.  */
-
-    // these are true if the style were set before the widget was realized
-    // (typcally in the constructor) but the actual GTK style must not be set
-    // before the widget has been "realized"
-    bool                 m_delayedFont:1;
-    bool                 m_delayedForegroundColour:1;
-    bool                 m_delayedBackgroundColour:1;
-    
-    // contains GTK's widgets internal information about non-default widget
-    // font and colours. we create one for each widget that gets any
-    // non-default attribute set via SetFont() or SetForegroundColour() /
-    // SetBackgroundColour().
-    GtkStyle            *m_widgetStyle;
+    bool                 m_acceptsFocus:1;      // true if not static
+    bool                 m_hasFocus:1;          // true if == FindFocus()
+    bool                 m_isScrolling:1;       // dragging scrollbar thumb?
+    bool                 m_clipPaintRegion:1;   // true after ScrollWindow()
+    bool                 m_needsStyleChange:1;  // May not be able to change
+                                                // background style until OnIdle
 
     // C++ has no virtual methods in the constrcutor of any class but we need
     // different methods of inserting a child window into a wxFrame,
@@ -211,6 +222,16 @@ public:
     wxInsertChildFunction  m_insertCallback;
 
     // implement the base class pure virtuals
+    virtual void DoGetTextExtent(const wxString& string,
+                               int *x, int *y,
+                               int *descent = NULL,
+                               int *externalLeading = NULL,
+                               const wxFont *theFont = NULL) const;
+
+#if wxUSE_MENUS_NATIVE
+    virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
+#endif // wxUSE_MENUS_NATIVE
+
     virtual void DoClientToScreen( int *x, int *y ) const;
     virtual void DoScreenToClient( int *x, int *y ) const;
     virtual void DoGetPosition( int *x, int *y ) const;
@@ -222,15 +243,36 @@ public:
     virtual void DoSetClientSize(int width, int height);
     virtual void DoMoveWindow(int x, int y, int width, int height);
 
+    virtual void DoCaptureMouse();
+    virtual void DoReleaseMouse();
+
 #if wxUSE_TOOLTIPS
     virtual void DoSetToolTip( wxToolTip *tip );
 #endif // wxUSE_TOOLTIPS
 
-    // common part of all ctors (can't be virtual because called from ctor)
+protected:
+    // common part of all ctors (not virtual because called from ctor)
     void Init();
 
+    // Called by ApplyWidgetStyle (which is called by SetFont() and
+    // SetXXXColour etc to apply style changed to native widgets) to create
+    // modified GTK style with non-standard attributes. If forceStyle=true,
+    // creates empty GtkRcStyle if there are no modifications, otherwise
+    // returns NULL in such case.
+    GtkRcStyle *CreateWidgetStyle(bool forceStyle = false);
+
+    // Overridden in many GTK widgets who have to handle subwidgets
+    virtual void ApplyWidgetStyle(bool forceStyle = false);
+
+    // helper function to ease native widgets wrapping, called by
+    // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
+    virtual void DoApplyWidgetStyle(GtkRcStyle *style);
+
 private:
-    DECLARE_NO_COPY_CLASS(wxWindow);
+    DECLARE_DYNAMIC_CLASS(wxWindowGTK)
+    wxDECLARE_NO_COPY_CLASS(wxWindowGTK);
 };
 
+extern WXDLLIMPEXP_CORE wxWindow *wxFindFocusedChild(wxWindowGTK *win);
+
 #endif // __GTKWINDOWH__