don't leave two conscutive separators after "moving" a standard menu item to the...

[wxWidgets.git] / include / wx / gtk / window.h

diff --git a/include/wx/gtk/window.h b/include/wx/gtk/window.h
index ce6b0332d4226c3137102f77969d91d3fa8669b8..607f344c215b813752ae42057cade69a8229d0bb 100644 (file)
--- a/include/wx/gtk/window.h
+++ b/include/wx/gtk/window.h
@@ -11,10 +11,14 @@
 #ifndef __GTKWINDOWH__
 #define __GTKWINDOWH__
 
 #ifndef __GTKWINDOWH__
 #define __GTKWINDOWH__
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

     #pragma interface
 #endif
 
     #pragma interface
 #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)
 //-----------------------------------------------------------------------------
 //-----------------------------------------------------------------------------
 // callback definition for inserting a window (internal)
 //-----------------------------------------------------------------------------


@@ -65,18 +69,19 @@ public:
     virtual bool Reparent( wxWindowBase *newParent );
 
     virtual void WarpPointer(int x, int y);
     virtual bool Reparent( wxWindowBase *newParent );
 
     virtual void WarpPointer(int x, int y);

-    virtual void CaptureMouse();
-    virtual void ReleaseMouse();

 
     virtual void Refresh( bool eraseBackground = TRUE,
                           const wxRect *rect = (const wxRect *) NULL );
 
     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 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,
     virtual int GetCharHeight() const;
     virtual int GetCharWidth() const;
     virtual void GetTextExtent(const wxString& string,


@@ -102,64 +107,90 @@ public:
 #if wxUSE_DRAG_AND_DROP
     virtual void SetDropTarget( wxDropTarget *dropTarget );
 #endif // wxUSE_DRAG_AND_DROP
 #if wxUSE_DRAG_AND_DROP
     virtual void SetDropTarget( wxDropTarget *dropTarget );
 #endif // wxUSE_DRAG_AND_DROP

+    
+#ifdef __WXGTK20__
+    virtual void AddChild( wxWindowBase *child );
+    virtual void RemoveChild( wxWindowBase *child );
+#endif

 
     // implementation
     // --------------
 
     virtual WXWidget GetHandle() const { return m_widget; }
 
 
     // implementation
     // --------------
 
     virtual WXWidget GetHandle() const { return m_widget; }
 

-    /* 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();
 
     virtual void OnInternalIdle();
 

-    /* For compatibility across platforms (not in event table) */
-    void OnIdle(wxIdleEvent& WXUNUSED(event)) {};
+    // Internal represention of Update()
+    void GtkUpdate();
+    
+    // For compatibility across platforms (not in event table)
+    void OnIdle(wxIdleEvent& WXUNUSED(event)) {}

 
     // wxGTK-specific: called recursively by Enable,
     // to give widgets an oppprtunity to correct their colours after they
     // have been changed by Enable
 
     // wxGTK-specific: called recursively by Enable,
     // to give widgets an oppprtunity to correct their colours after they
     // have been changed by Enable

-    virtual void OnParentEnable( bool WXUNUSED(enable) ) {};
+    virtual void OnParentEnable( bool WXUNUSED(enable) ) {}

 
 

-    /* used by all window classes in the widget creation process */
+    // Used by all window classes in the widget creation process.

     bool PreCreation( wxWindowGTK *parent, const wxPoint &pos, const wxSize &size );
     void PostCreation();
 
     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 */
+    // 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);
     void DoAddChild(wxWindowGTK *child);

-
-    /* 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. */
-
+    
+    // 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 nor 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 );
 
     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();
+#ifdef __WXGTK20__
+    // Returns the default context which usually is anti-aliased
+    PangoContext   *GtkGetPangoDefaultContext();
+    
+    // Returns the X11 context which renders on the X11 client
+    // side (which can be remote) and which usually is not
+    // anti-aliased and is thus faster
+    PangoContext   *GtkGetPangoX11Context();
+    PangoContext   *m_x11Context;
+#endif

 
 #if wxUSE_TOOLTIPS
     virtual void ApplyToolTip( GtkTooltips *tips, const wxChar *tip );
 #endif // wxUSE_TOOLTIPS
 
 
 #if wxUSE_TOOLTIPS
     virtual void ApplyToolTip( GtkTooltips *tips, const wxChar *tip );
 #endif // wxUSE_TOOLTIPS
 

-    // called from GTK signales handlers. it indicates that
+    // Called from GTK signales handlers. it indicates that

     // the layouting functions have to be called later on
     // (i.e. in idle time, implemented in OnInternalIdle() ).
     void GtkUpdateSize() { m_sizeSet = FALSE; }
     // the layouting functions have to be called later on
     // (i.e. in idle time, implemented in OnInternalIdle() ).
     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;
     // position and size of the window
     int                  m_x, m_y;
     int                  m_width, m_height;


@@ -167,16 +198,26 @@ public:
 
     // see the docs in src/gtk/window.cpp
     GtkWidget           *m_widget;          // mostly the widget seen by the rest of GTK
 
     // 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 wxWindows
-    
+    GtkWidget           *m_wxwindow;        // mostly the client area as per wxWidgets
+

     // this widget will be queried for GTK's focus events
     GtkWidget           *m_focusWidget;
 
     // this widget will be queried for GTK's focus events
     GtkWidget           *m_focusWidget;
 

-#if HAVE_XIM
-    // XIM support for wxWindows
+#ifdef __WXGTK20__
+    wxGtkIMData         *m_imData;
+#else
+#if HAVE_XIM && !defined(__WXGTK20__)
+    // XIM support for wxWidgets

     GdkIC               *m_ic;
     GdkICAttr           *m_icattr;
 #endif
     GdkIC               *m_ic;
     GdkICAttr           *m_icattr;
 #endif

+#endif
+
+#ifndef __WXGTK20__
+    // The area to be cleared (and not just refreshed)
+    // We cannot make this distinction under GTK 2.0.
+    wxRegion             m_clearRegion;
+#endif

 
     // scrolling stuff
     GtkAdjustment       *m_hAdjust,*m_vAdjust;
 
     // scrolling stuff
     GtkAdjustment       *m_hAdjust,*m_vAdjust;


@@ -191,26 +232,16 @@ public:
     bool                 m_hasVMT:1;
     bool                 m_sizeSet:1;
     bool                 m_resizing: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_isListBox:1;         // faster than IS_KIND_OF
-    bool                 m_isFrame:1;           // faster than IS_KIND_OF
-    bool                 m_acceptsFocus:1;      // not wxStaticBox, not wxStaticBitmap etc.
-    bool                 m_isScrolling;
-    bool                 m_clipPaintRegion;     // TRUE after ScrollWindow()
-    bool                 m_queuedFullRedraw;    // TRUE after DoMoveWindow
-
-    // 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_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()
+#ifdef __WXGTK20__
+    bool                 m_dirtyTabOrder:1;     // tab order changed, GTK focus
+                                                // chain needs update
+#endif
+    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,
 
     // C++ has no virtual methods in the constrcutor of any class but we need
     // different methods of inserting a child window into a wxFrame,


@@ -229,12 +260,37 @@ public:
     virtual void DoSetClientSize(int width, int height);
     virtual void DoMoveWindow(int x, int y, int width, int height);
 
     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
 
 #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();
     void Init();

+    
+#ifdef __WXGTK20__
+    virtual void DoMoveInTabOrder(wxWindow *win, MoveKind move);
+
+    // Copies m_children tab order to GTK focus chain:
+    void RealizeTabOrder();
+#endif
+    
+    // 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_DYNAMIC_CLASS(wxWindowGTK)
 
 private:
     DECLARE_DYNAMIC_CLASS(wxWindowGTK)