Regenerated FL docs; applied patch [ #511363 ] Dialogs no longer need wx.rc

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

diff --git a/include/wx/gtk/window.h b/include/wx/gtk/window.h
index 0d38f748bd0e2fe45e149bdef2136e4a7648e49a..9c9bb4d739d9e103f882a56ddea547657f374f96 100644 (file)
--- a/include/wx/gtk/window.h
+++ b/include/wx/gtk/window.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

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


@@ -19,36 +19,36 @@
 // callback definition for inserting a window (internal)
 //-----------------------------------------------------------------------------
 
 // callback definition for inserting a window (internal)
 //-----------------------------------------------------------------------------
 

-typedef void (*wxInsertChildFunction)( wxWindow*, wxWindow* );
+class wxWindowGTK;
+typedef void (*wxInsertChildFunction)( wxWindowGTK*, wxWindowGTK* );

 
 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------

-// wxWindow
+// wxWindowGTK

 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------
 

-class wxWindow : public wxWindowBase
+class wxWindowGTK : public wxWindowBase

 {
 {

-    DECLARE_DYNAMIC_CLASS(wxWindow)
-

 public:
     // creating the window
     // -------------------
 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);
     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
     // -------------------------------------------
 
     // implement base class (pure) virtual methods
     // -------------------------------------------

+

     virtual bool Destroy();
 
     virtual void Raise();
     virtual bool Destroy();
 
     virtual void Raise();


@@ -62,14 +62,13 @@ public:
     virtual void SetFocus();
     virtual bool AcceptsFocus() const;
 
     virtual void SetFocus();
     virtual bool AcceptsFocus() const;
 

-    virtual bool Reparent( wxWindow *newParent );
+    virtual bool Reparent( wxWindowBase *newParent );

 
     virtual void WarpPointer(int x, int y);
 
     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 Update();

     virtual void Clear();
 
     virtual bool SetBackgroundColour( const wxColour &colour );
     virtual void Clear();
 
     virtual bool SetBackgroundColour( const wxColour &colour );


@@ -86,10 +85,9 @@ public:
                                const wxFont *theFont = (const wxFont *) NULL)
                                const;
 
                                const wxFont *theFont = (const wxFont *) NULL)
                                const;
 

-    virtual void ClientToScreen( int *x, int *y ) const;
-    virtual void ScreenToClient( int *x, int *y ) const;
-
-    virtual bool PopupMenu( wxMenu *menu, int x, int y );
+#if wxUSE_MENUS_NATIVE
+    virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
+#endif // wxUSE_MENUS_NATIVE

 
     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
                                int range, bool refresh = TRUE );
 
     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
                                int range, bool refresh = TRUE );


@@ -107,86 +105,126 @@ public:
     // implementation
     // --------------
 
     // implementation
     // --------------
 

-    // wxWindows callbacks
-    void OnKeyDown( wxKeyEvent &event );
-
-    // also sets the global flag
-    void SetScrolling(bool scroll);
+    virtual WXWidget GetHandle() const { return m_widget; }

 
 

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

-    /* 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)) {}

 
 

-    /* used by all classes in the widget creation process */
-    void PreCreation( wxWindow *parent, wxWindowID id, const wxPoint &pos,
-            const wxSize &size, long style, const wxString &name );
-    void PostCreation();
+    // 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) ) {}

 
 

-    void InsertChild(wxWindow *child) { (*m_insertCallback)(this, child); }
-    void DoAddChild(wxWindow *child) { AddChild(child); InsertChild(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. */
+    // 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 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();
     GtkStyle *GetWidgetStyle();

+
+    // Called by SetFont() and SetXXXColour etc

     void SetWidgetStyle();
     void SetWidgetStyle();

+
+    // Overridden in many GTK widgets who have to handle subwidgets

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

-    // called from GTK signales handlers
-    void UpdateSize() { m_sizeSet = FALSE; }
-    void InternalSetPosition(int x, int y) { m_x = x; m_y = y; }
-    void InternalSetSize(int w, int h)
-        { m_width = w; m_height = h; UpdateSize(); }
+    // 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; }

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

+    int                  m_oldClientWidth,m_oldClientHeight;

 
     // see the docs in src/gtk/window.cpp
 
     // see the docs in src/gtk/window.cpp

-    GtkWidget           *m_widget;
-    GtkWidget           *m_wxwindow;
+    GtkWidget           *m_widget;          // mostly the widget seen by the rest of GTK
+    GtkWidget           *m_wxwindow;        // mostly the client area as per wxWindows
+
+    // this widget will be queried for GTK's focus events
+    GtkWidget           *m_focusWidget;
+
+#if HAVE_XIM
+    // XIM support for wxWindows
+    GdkIC               *m_ic;
+    GdkICAttr           *m_icattr;
+#endif

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

-    float                m_oldHorizontalPos,
-                         m_oldVerticalPos;
-    GdkGC               *m_scrollGC;
+    float                m_oldHorizontalPos;
+    float                m_oldVerticalPos;

 
     // extra (wxGTK-specific) flags
 
     // extra (wxGTK-specific) flags

-    bool                 m_needParent:1;    /* ! wxFrame, wxDialog, wxNotebookPage ?  */
+    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_hasScrolling:1;

-    bool                 m_isScrolling:1;

     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_isFrame:1;       /* faster than IS_KIND_OF */
-    bool                 m_acceptsFocus:1;  /* ! wxStaticBox etc.  */
-
+    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;
 
     GtkStyle            *m_widgetStyle;
 

+    // C++ has no virtual methods in the constrcutor of any class but we need
+    // different methods of inserting a child window into a wxFrame,
+    // wxMDIFrame, wxNotebook etc. this is the callback that will get used.

     wxInsertChildFunction  m_insertCallback;
 
     // implement the base class pure virtuals
     wxInsertChildFunction  m_insertCallback;
 
     // implement the base class pure virtuals

+    virtual void DoClientToScreen( int *x, int *y ) const;
+    virtual void DoScreenToClient( int *x, int *y ) const;

     virtual void DoGetPosition( int *x, int *y ) const;
     virtual void DoGetSize( int *width, int *height ) const;
     virtual void DoGetClientSize( int *width, int *height ) const;
     virtual void DoGetPosition( int *x, int *y ) const;
     virtual void DoGetSize( int *width, int *height ) const;
     virtual void DoGetClientSize( int *width, int *height ) const;


@@ -194,6 +232,10 @@ public:
                            int width, int height,
                            int sizeFlags = wxSIZE_AUTO);
     virtual void DoSetClientSize(int width, int height);
                            int width, int height,
                            int sizeFlags = wxSIZE_AUTO);
     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 );
 
 #if wxUSE_TOOLTIPS
     virtual void DoSetToolTip( wxToolTip *tip );


@@ -203,7 +245,10 @@ public:
     void Init();
 
 private:
     void Init();
 
 private:

-    DECLARE_EVENT_TABLE()
+    DECLARE_DYNAMIC_CLASS(wxWindowGTK)
+    DECLARE_NO_COPY_CLASS(wxWindowGTK)

 };
 
 };
 

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

 #endif // __GTKWINDOWH__
 #endif // __GTKWINDOWH__