include/wx/gtk/toplevel.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/gtk/toplevel.h
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling, Julian Smart
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef _WX_GTK_TOPLEVEL_H_
  11 #define _WX_GTK_TOPLEVEL_H_
  12
  13 //-----------------------------------------------------------------------------
  14 // wxTopLevelWindowGTK
  15 //-----------------------------------------------------------------------------
  16
  17 class WXDLLIMPEXP_CORE wxTopLevelWindowGTK : public wxTopLevelWindowBase
  18 {
  19     DECLARE_EVENT_TABLE()
  20 public:
  21     // construction
  22     wxTopLevelWindowGTK() { Init(); }
  23     wxTopLevelWindowGTK(wxWindow *parent,
  24                         wxWindowID id,
  25                         const wxString& title,
  26                         const wxPoint& pos = wxDefaultPosition,
  27                         const wxSize& size = wxDefaultSize,
  28                         long style = wxDEFAULT_FRAME_STYLE,
  29                         const wxString& name = wxFrameNameStr)
  30     {
  31         Init();
  32
  33         Create(parent, id, title, pos, size, style, name);
  34     }
  35
  36     bool Create(wxWindow *parent,
  37                 wxWindowID id,
  38                 const wxString& title,
  39                 const wxPoint& pos = wxDefaultPosition,
  40                 const wxSize& size = wxDefaultSize,
  41                 long style = wxDEFAULT_FRAME_STYLE,
  42                 const wxString& name = wxFrameNameStr);
  43
  44     virtual ~wxTopLevelWindowGTK();
  45
  46     // implement base class pure virtuals
  47     virtual void Maximize(bool maximize = true);
  48     virtual bool IsMaximized() const;
  49     virtual void Iconize(bool iconize = true);
  50     virtual bool IsIconized() const;
  51     virtual void SetIcons(const wxIconBundle& icons);
  52     virtual void Restore();
  53
  54     virtual bool EnableCloseButton(bool enable = true);
  55
  56     virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL);
  57     virtual bool IsFullScreen() const { return m_fsIsShowing; };
  58
  59     virtual bool SetShape(const wxRegion& region);
  60
  61     virtual void RequestUserAttention(int flags = wxUSER_ATTENTION_INFO);
  62
  63     virtual void SetWindowStyleFlag( long style );
  64
  65     virtual bool Show(bool show = true);
  66
  67     virtual void Raise();
  68
  69     virtual bool IsActive();
  70
  71     virtual void SetTitle( const wxString &title );
  72     virtual wxString GetTitle() const { return m_title; }
  73
  74     virtual bool SetTransparent(wxByte alpha);
  75     virtual bool CanSetTransparent();
  76
  77     // Experimental, to allow help windows to be
  78     // viewable from within modal dialogs
  79     virtual void AddGrab();
  80     virtual void RemoveGrab();
  81     virtual bool IsGrabbed() const { return m_grabbed; }
  82
  83     // implementation from now on
  84     // --------------------------
  85
  86     // GTK callbacks
  87     virtual void OnInternalIdle();
  88
  89     // Respond to system colour change
  90     void OnSysColourChanged(wxSysColourChangedEvent& event);
  91
  92     // do *not* call this to iconize the frame, this is a private function!
  93     void SetIconizeState(bool iconic);
  94
  95     GtkWidget    *m_mainWidget;
  96
  97     bool          m_fsIsShowing;         /* full screen */
  98     int           m_fsSaveGdkFunc, m_fsSaveGdkDecor;
  99     wxRect        m_fsSaveFrame;
 100
 101     // m_windowStyle translated to GDK's terms
 102     int           m_gdkFunc,
 103                   m_gdkDecor;
 104
 105     // size of WM decorations
 106     wxSize m_decorSize;
 107
 108     // private gtk_timeout_add result for mimicing wxUSER_ATTENTION_INFO and
 109     // wxUSER_ATTENTION_ERROR difference, -2 for no hint, -1 for ERROR hint, rest for GtkTimeout handle.
 110     int m_urgency_hint;
 111
 112     // return the size of the window without WM decorations
 113     void GTKDoGetSize(int *width, int *height) const;
 114
 115     // whether frame extents are accurate
 116     virtual bool IsDecorCacheable() const;
 117
 118 protected:
 119     // give hints to the Window Manager for how the size
 120     // of the TLW can be changed by dragging
 121     virtual void DoSetSizeHints( int minW, int minH,
 122                                  int maxW, int maxH,
 123                                  int incW, int incH);
 124     // common part of all ctors
 125     void Init();
 126
 127     // move the window to the specified location and resize it
 128     virtual void DoMoveWindow(int x, int y, int width, int height);
 129
 130     // take into account WM decorations here
 131     virtual void DoSetSize(int x, int y,
 132                            int width, int height,
 133                            int sizeFlags = wxSIZE_AUTO);
 134
 135     // override these methods to take into account tool/menu/statusbars
 136     virtual void DoGetClientSize(int *width, int *height) const;
 137
 138     // string shown in the title bar
 139     wxString m_title;
 140
 141 private:
 142     // is the frame currently iconized?
 143     bool m_isIconized;
 144
 145     // is the frame currently grabbed explicitly by the application?
 146     bool m_grabbed;
 147 };
 148
 149 #endif // _WX_GTK_TOPLEVEL_H_