Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/gtk/toplevel.h b/include/wx/gtk/toplevel.h
index 0e6dce880131982f3b724ec2a0792470e6363bf2..768f2e14f5b9662971ce27e8727cafd6fc30924d 100644 (file)
--- a/include/wx/gtk/toplevel.h
+++ b/include/wx/gtk/toplevel.h
@@ -7,21 +7,16 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-
-#ifndef __GTKTOPLEVELH__
-#define __GTKTOPLEVELH__
-
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "toplevel.h"
-#endif
-
+#ifndef _WX_GTK_TOPLEVEL_H_
+#define _WX_GTK_TOPLEVEL_H_
 
 //-----------------------------------------------------------------------------
 // wxTopLevelWindowGTK
 //-----------------------------------------------------------------------------
 
-class wxTopLevelWindowGTK : public wxTopLevelWindowBase
+class WXDLLIMPEXP_CORE wxTopLevelWindowGTK : public wxTopLevelWindowBase
 {
+    typedef wxTopLevelWindowBase base_type;
 public:
     // construction
     wxTopLevelWindowGTK() { Init(); }
@@ -49,78 +44,121 @@ public:
     virtual ~wxTopLevelWindowGTK();
 
     // implement base class pure virtuals
-    virtual void Maximize(bool maximize = TRUE);
+    virtual void Maximize(bool maximize = true);
     virtual bool IsMaximized() const;
-    virtual void Iconize(bool iconize = TRUE);
+    virtual void Iconize(bool iconize = true);
     virtual bool IsIconized() const;
-    virtual void SetIcon(const wxIcon& icon);
     virtual void SetIcons(const wxIconBundle& icons);
     virtual void Restore();
 
+    virtual bool EnableCloseButton(bool enable = true);
+
+    virtual void ShowWithoutActivating();
     virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL);
-    virtual bool IsFullScreen() const { return m_fsIsShowing; };
+    virtual bool IsFullScreen() const { return m_fsIsShowing; }
 
-    virtual bool SetShape(const wxRegion& region);
+    virtual void RequestUserAttention(int flags = wxUSER_ATTENTION_INFO);
 
-    virtual bool Show(bool show = TRUE);
+    virtual void SetWindowStyleFlag( long style );
+
+    virtual bool Show(bool show = true);
+
+    virtual void Raise();
 
     virtual bool IsActive();
 
     virtual void SetTitle( const wxString &title );
     virtual wxString GetTitle() const { return m_title; }
 
+    virtual void SetLabel(const wxString& label) { SetTitle( label ); }
+    virtual wxString GetLabel() const            { return GetTitle(); }
+
+
+    virtual bool SetTransparent(wxByte alpha);
+    virtual bool CanSetTransparent();
+
     // Experimental, to allow help windows to be
     // viewable from within modal dialogs
     virtual void AddGrab();
     virtual void RemoveGrab();
     virtual bool IsGrabbed() const { return m_grabbed; }
 
+
+    virtual void Refresh( bool eraseBackground = true,
+                          const wxRect *rect = (const wxRect *) NULL );
+
     // implementation from now on
     // --------------------------
 
-    // move the window to the specified location and resize it: this is called
-    // from both DoSetSize() and DoSetClientSize()
-    virtual void DoMoveWindow(int x, int y, int width, int height);
-
     // GTK callbacks
-    virtual void GtkOnSize( int x, int y, int width, int height );
     virtual void OnInternalIdle();
 
+    virtual void GTKHandleRealized();
+
     // do *not* call this to iconize the frame, this is a private function!
     void SetIconizeState(bool iconic);
 
-    wxString      m_title;
-    int           m_miniEdge,
-                  m_miniTitle;
     GtkWidget    *m_mainWidget;
-    bool          m_insertInClientArea;  /* not from within OnCreateXXX */
 
     bool          m_fsIsShowing;         /* full screen */
-    long          m_fsSaveGdkFunc, m_fsSaveGdkDecor;
-    long          m_fsSaveFlag;
+    int           m_fsSaveGdkFunc, m_fsSaveGdkDecor;
     wxRect        m_fsSaveFrame;
 
     // m_windowStyle translated to GDK's terms
-    long          m_gdkFunc,
+    int           m_gdkFunc,
                   m_gdkDecor;
 
+    // size of WM decorations
+    wxSize m_decorSize;
+
+    // private gtk_timeout_add result for mimicing wxUSER_ATTENTION_INFO and
+    // wxUSER_ATTENTION_ERROR difference, -2 for no hint, -1 for ERROR hint, rest for GtkTimeout handle.
+    int m_urgency_hint;
+    // timer for detecting WM with broken _NET_REQUEST_FRAME_EXTENTS handling
+    unsigned m_netFrameExtentsTimerId;
+
+    // return the size of the window without WM decorations
+    void GTKDoGetSize(int *width, int *height) const;
+
+    void GTKUpdateDecorSize(const wxSize& decorSize);
+
 protected:
-    // common part of all ctors
-    void Init();
+    // give hints to the Window Manager for how the size
+    // of the TLW can be changed by dragging
+    virtual void DoSetSizeHints( int minW, int minH,
+                                 int maxW, int maxH,
+                                 int incW, int incH);
+    // move the window to the specified location and resize it
+    virtual void DoMoveWindow(int x, int y, int width, int height);
 
-    // override wxWindow methods to take into account tool/menu/statusbars
+    // take into account WM decorations here
     virtual void DoSetSize(int x, int y,
                            int width, int height,
                            int sizeFlags = wxSIZE_AUTO);
 
     virtual void DoSetClientSize(int width, int height);
-    virtual void DoGetClientSize( int *width, int *height ) const;
+    virtual void DoGetClientSize(int *width, int *height) const;
+
+    // string shown in the title bar
+    wxString m_title;
+
+    bool m_deferShow;
+
+private:
+    void Init();
+    wxSize& GetCachedDecorSize();
+
+    // size hint increments
+    int m_incWidth, m_incHeight;
 
     // is the frame currently iconized?
     bool m_isIconized;
-    // is the frame currently grabbed explicitly
-    // by the application?
+
+    // is the frame currently grabbed explicitly by the application?
     bool m_grabbed;
+
+    bool m_updateDecorSize;
+    bool m_deferShowAllowed;
 };
 
-#endif // __GTKTOPLEVELH__
+#endif // _WX_GTK_TOPLEVEL_H_