use wx-style header and commets; fix indentation to be 4 spaces; move Doxygen comment...

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

diff --git a/include/wx/gtk1/window.h b/include/wx/gtk1/window.h
index abf8233032ae99e3343c8df2ff6dc123a9e8fef2..1fb59e507e21b6e1ec44d490ae5fe1202c115a2f 100644 (file)
--- a/include/wx/gtk1/window.h
+++ b/include/wx/gtk1/window.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        wx/gtk/window.h
+// Name:        wx/gtk1/window.h

 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$
 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$


@@ -18,7 +18,7 @@ struct wxGtkIMData;
 // callback definition for inserting a window (internal)
 //-----------------------------------------------------------------------------
 
 // callback definition for inserting a window (internal)
 //-----------------------------------------------------------------------------
 

-class WXDLLIMPEXP_CORE wxWindowGTK;
+class WXDLLIMPEXP_FWD_CORE wxWindowGTK;

 typedef void (*wxInsertChildFunction)( wxWindowGTK*, wxWindowGTK* );
 
 //-----------------------------------------------------------------------------
 typedef void (*wxInsertChildFunction)( wxWindowGTK*, wxWindowGTK* );
 
 //-----------------------------------------------------------------------------


@@ -48,16 +48,18 @@ public:
     // implement base class (pure) virtual methods
     // -------------------------------------------
 
     // implement base class (pure) virtual methods
     // -------------------------------------------
 

-    virtual void SetLabel( const wxString &label ) {}
-    virtual wxString GetLabel() const {}
+    virtual void SetLabel(const wxString& WXUNUSED(label)) { }
+    virtual wxString GetLabel() const { return wxEmptyString; }

 
     virtual bool Destroy();
 
     virtual void Raise();
     virtual void Lower();
 
 
     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;
 
 
     virtual bool IsRetained() const;
 


@@ -68,7 +70,7 @@ public:
 
     virtual void WarpPointer(int x, int y);
 
 
     virtual void WarpPointer(int x, int y);
 

-    virtual void Refresh( bool eraseBackground = TRUE,
+    virtual void Refresh( bool eraseBackground = true,

                           const wxRect *rect = (const wxRect *) NULL );
     virtual void Update();
     virtual void ClearBackground();
                           const wxRect *rect = (const wxRect *) NULL );
     virtual void Update();
     virtual void ClearBackground();


@@ -94,8 +96,8 @@ public:
 #endif // wxUSE_MENUS_NATIVE
 
     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
 #endif // wxUSE_MENUS_NATIVE
 
     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 int GetScrollPos( int orient ) const;
     virtual int GetScrollThumb( int orient ) const;
     virtual int GetScrollRange( int orient ) const;


@@ -106,10 +108,9 @@ public:
     virtual void SetDropTarget( wxDropTarget *dropTarget );
 #endif // 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
+    virtual bool IsDoubleBuffered() const { return false; }
+
+    GdkWindow* GTKGetDrawingWindow() const;

 
     // implementation
     // --------------
 
     // implementation
     // --------------


@@ -127,11 +128,6 @@ public:
     // For compatibility across platforms (not in event table)
     void OnIdle(wxIdleEvent& WXUNUSED(event)) {}
 
     // 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
-    virtual void OnParentEnable( bool WXUNUSED(enable) ) {}
-

     // Used by all window classes in the widget creation process.
     bool PreCreation( wxWindowGTK *parent, const wxPoint &pos, const wxSize &size );
     void PostCreation();
     // Used by all window classes in the widget creation process.
     bool PreCreation( wxWindowGTK *parent, const wxPoint &pos, const wxSize &size );
     void PostCreation();


@@ -151,27 +147,13 @@ public:
     // 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.
     // 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
+    // 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 );
 
     // 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 );
 

-#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
-    // MR: Now returns the default pango_context for the widget as GtkGetPangoDefaultContext to
-    // not depend on libpangox - which is completely deprecated.
-    //BCI: Remove GtkGetPangoX11Context and m_x11Context completely when symbols may be removed
-    PangoContext   *GtkGetPangoX11Context();
-    PangoContext   *m_x11Context; // MR: Now unused
-#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


@@ -180,10 +162,10 @@ public:
     // scrolbar in sync (this does not generate any wx events)
     void GtkUpdateScrollbar(int orient);
 
     // scrolbar in sync (this does not generate any wx events)
     void GtkUpdateScrollbar(int orient);
 

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

     // the layouting functions have to be called later on
     // (i.e. in idle time, implemented in OnInternalIdle() ).
     // the layouting functions have to be called later on
     // (i.e. in idle time, implemented in OnInternalIdle() ).

-    void GtkUpdateSize() { 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),
 
     // fix up the mouse event coords, used by wxListBox only so far
     virtual void FixUpMouseEvent(GtkWidget * WXUNUSED(widget),


@@ -191,10 +173,10 @@ public:
                                  wxCoord& WXUNUSED(y)) { }
 
     // is this window transparent for the mouse events (as wxStaticBox is)?
                                  wxCoord& WXUNUSED(y)) { }
 
     // is this window transparent for the mouse events (as wxStaticBox is)?

-    virtual bool IsTransparentForMouse() const { return FALSE; }
+    virtual bool IsTransparentForMouse() const { return false; }

 
     // is this a radiobutton (used by radiobutton code itself only)?
 
     // is this a radiobutton (used by radiobutton code itself only)?

-    virtual bool IsRadioButton() const { return FALSE; }
+    virtual bool IsRadioButton() const { return false; }

 
     // position and size of the window
     int                  m_x, m_y;
 
     // position and size of the window
     int                  m_x, m_y;


@@ -208,21 +190,15 @@ public:
     // 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;
 

-#ifdef __WXGTK20__
-    wxGtkIMData         *m_imData;
-#else // GTK 1

 #ifdef HAVE_XIM
     // XIM support for wxWidgets
     GdkIC               *m_ic;
     GdkICAttr           *m_icattr;
 #endif // HAVE_XIM
 #ifdef HAVE_XIM
     // XIM support for wxWidgets
     GdkIC               *m_ic;
     GdkICAttr           *m_icattr;
 #endif // HAVE_XIM

-#endif // GTK 2/1

 
 

-#ifndef __WXGTK20__

     // The area to be cleared (and not just refreshed)
     // We cannot make this distinction under GTK 2.0.
     wxRegion             m_clearRegion;
     // 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;


@@ -240,11 +216,7 @@ public:
     bool                 m_acceptsFocus:1;      // true if not static
     bool                 m_hasFocus:1;          // true if == FindFocus()
     bool                 m_isScrolling:1;       // dragging scrollbar thumb?
     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_clipPaintRegion:1;   // true after ScrollWindow()

     bool                 m_needsStyleChange:1;  // May not be able to change
                                                 // background style until OnIdle
 
     bool                 m_needsStyleChange:1;  // May not be able to change
                                                 // background style until OnIdle
 


@@ -276,13 +248,6 @@ protected:
     // common part of all ctors (not virtual because called from ctor)
     void Init();
 
     // common part of all ctors (not virtual because called from ctor)
     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,
     // 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,


@@ -293,7 +258,7 @@ protected:
     // Overridden in many GTK widgets who have to handle subwidgets
     virtual void ApplyWidgetStyle(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 
+    // helper function to ease native widgets wrapping, called by

     // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
     virtual void DoApplyWidgetStyle(GtkRcStyle *style);
 
     // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
     virtual void DoApplyWidgetStyle(GtkRcStyle *style);