Clarified wxPropertyGrid::HitTest() docs

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

diff --git a/include/wx/gtk1/window.h b/include/wx/gtk1/window.h
index a2e8a9068b7be7598d8446f7d0c909a8f91225f4..0f5f08f3cdb801dbdf1e047969ac85e284c42ead 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$


@@ -7,26 +7,25 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-

 #ifndef __GTKWINDOWH__
 #define __GTKWINDOWH__
 
 #ifndef __GTKWINDOWH__
 #define __GTKWINDOWH__
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #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)
 //-----------------------------------------------------------------------------
 

-class wxWindowGTK;
+class WXDLLIMPEXP_FWD_CORE wxWindowGTK;

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

-class wxWindowGTK : public wxWindowBase
+class WXDLLIMPEXP_CORE wxWindowGTK : public wxWindowBase

 {
 public:
     // creating the window
 {
 public:
     // creating the window


@@ -49,13 +48,18 @@ public:
     // implement base class (pure) virtual methods
     // -------------------------------------------
 
     // 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 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;
 


@@ -66,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();


@@ -76,12 +80,14 @@ public:
     virtual bool SetCursor( const wxCursor &cursor );
     virtual bool SetFont( const wxFont &font );
 
     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,
     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,
+                               int *descent = NULL,
+                               int *externalLeading = NULL,

                                const wxFont *theFont = (const wxFont *) NULL)
                                const;
 
                                const wxFont *theFont = (const wxFont *) NULL)
                                const;
 


@@ -90,18 +96,22 @@ 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 void ScrollWindow( int dx, int dy,
     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
 
 
 #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
     // --------------
 
     // implementation
     // --------------
 


@@ -114,15 +124,10 @@ public:
 
     // Internal represention of Update()
     void GtkUpdate();
 
     // Internal represention of Update()
     void GtkUpdate();

-    
+

     // 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();


@@ -131,7 +136,7 @@ public:
     // to class not by using virtual functions but by using
     // the m_insertCallback.
     void DoAddChild(wxWindowGTK *child);
     // 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
     // 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


@@ -142,32 +147,25 @@ 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
-    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
+    // 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 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),


@@ -175,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;


@@ -192,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__
-    GtkIMMulticontext   *m_imContext;
-#else
-#if HAVE_XIM
+#ifdef HAVE_XIM

     // XIM support for wxWidgets
     GdkIC               *m_ic;
     GdkICAttr           *m_icattr;
     // XIM support for wxWidgets
     GdkIC               *m_ic;
     GdkICAttr           *m_icattr;

-#endif
-#endif
+#endif // HAVE_XIM

 
 

-#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;


@@ -224,8 +216,9 @@ 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()
-    bool                 m_queuedFullRedraw:1;  // TRUE after DoMoveWindow
+    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,
 
     // C++ has no virtual methods in the constrcutor of any class but we need
     // different methods of inserting a child window into a wxFrame,


@@ -246,7 +239,7 @@ public:
 
     virtual void DoCaptureMouse();
     virtual void DoReleaseMouse();
 
     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


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


@@ -264,16 +257,16 @@ 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);
 
 private:
     DECLARE_DYNAMIC_CLASS(wxWindowGTK)
     // ApplyWidgetStyle -- override this, not ApplyWidgetStyle
     virtual void DoApplyWidgetStyle(GtkRcStyle *style);
 
 private:
     DECLARE_DYNAMIC_CLASS(wxWindowGTK)

-    DECLARE_NO_COPY_CLASS(wxWindowGTK)
+    wxDECLARE_NO_COPY_CLASS(wxWindowGTK);

 };
 
 };
 

-extern wxWindow *wxFindFocusedChild(wxWindowGTK *win);
+extern WXDLLIMPEXP_CORE wxWindow *wxFindFocusedChild(wxWindowGTK *win);

 
 #endif // __GTKWINDOWH__
 
 #endif // __GTKWINDOWH__