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 public:
  20     // construction
  21     wxTopLevelWindowGTK() { Init(); }
  22     wxTopLevelWindowGTK(wxWindow *parent,
  23                         wxWindowID id,
  24                         const wxString& title,
  25                         const wxPoint& pos = wxDefaultPosition,
  26                         const wxSize& size = wxDefaultSize,
  27                         long style = wxDEFAULT_FRAME_STYLE,
  28                         const wxString& name = wxFrameNameStr)
  29     {
  30         Init();
  31
  32         Create(parent, id, title, pos, size, style, name);
  33     }
  34
  35     bool Create(wxWindow *parent,
  36                 wxWindowID id,
  37                 const wxString& title,
  38                 const wxPoint& pos = wxDefaultPosition,
  39                 const wxSize& size = wxDefaultSize,
  40                 long style = wxDEFAULT_FRAME_STYLE,
  41                 const wxString& name = wxFrameNameStr);
  42
  43     virtual ~wxTopLevelWindowGTK();
  44
  45     // implement base class pure virtuals
  46     virtual void Maximize(bool maximize = true);
  47     virtual bool IsMaximized() const;
  48     virtual void Iconize(bool iconize = true);
  49     virtual bool IsIconized() const;
  50     virtual void SetIcon(const wxIcon& icon);
  51     virtual void SetIcons(const wxIconBundle& icons);
  52     virtual void Restore();
  53
  54     virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL);
  55     virtual bool IsFullScreen() const { return m_fsIsShowing; };
  56
  57     virtual bool SetShape(const wxRegion& region);
  58
  59     virtual void RequestUserAttention(int flags = wxUSER_ATTENTION_INFO);
  60
  61     virtual void SetWindowStyleFlag( long style );
  62
  63     virtual bool Show(bool show = true);
  64
  65     virtual void Raise();
  66
  67     virtual bool IsActive();
  68
  69     virtual void SetTitle( const wxString &title );
  70     virtual wxString GetTitle() const { return m_title; }
  71
  72     virtual bool SetTransparent(wxByte alpha);
  73     virtual bool CanSetTransparent();
  74
  75     // Experimental, to allow help windows to be
  76     // viewable from within modal dialogs
  77     virtual void AddGrab();
  78     virtual void RemoveGrab();
  79     virtual bool IsGrabbed() const { return m_grabbed; }
  80
  81     // implementation from now on
  82     // --------------------------
  83
  84     // GTK callbacks
  85     virtual void GtkOnSize();
  86     virtual void OnInternalIdle();
  87
  88     // do *not* call this to iconize the frame, this is a private function!
  89     void SetIconizeState(bool iconic);
  90
  91     int           m_miniEdge,
  92                   m_miniTitle;
  93     GtkWidget    *m_mainWidget;
  94     bool          m_insertInClientArea;  /* not from within OnCreateXXX */
  95
  96     bool          m_fsIsShowing;         /* full screen */
  97     long          m_fsSaveGdkFunc, m_fsSaveGdkDecor;
  98     long          m_fsSaveFlag;
  99     wxRect        m_fsSaveFrame;
 100
 101     // m_windowStyle translated to GDK's terms
 102     long          m_gdkFunc,
 103                   m_gdkDecor;
 104
 105     // private gtk_timeout_add result for mimicing wxUSER_ATTENTION_INFO and
 106     // wxUSER_ATTENTION_ERROR difference, -2 for no hint, -1 for ERROR hint, rest for GtkTimeout handle.
 107     int m_urgency_hint;
 108
 109 protected:
 110     // common part of all ctors
 111     void Init();
 112
 113     // move the window to the specified location and resize it: this is called
 114     // from both DoSetSize() and DoSetClientSize()
 115     virtual void DoMoveWindow(int x, int y, int width, int height);
 116
 117     // override wxWindow methods to take into account tool/menu/statusbars
 118     virtual void DoSetSize(int x, int y,
 119                            int width, int height,
 120                            int sizeFlags = wxSIZE_AUTO);
 121
 122     virtual void DoSetClientSize(int width, int height);
 123     virtual void DoGetClientSize( int *width, int *height ) const;
 124
 125     wxString      m_title;
 126
 127     // is the frame currently iconized?
 128     bool m_isIconized;
 129     // is the frame currently grabbed explicitly
 130     // by the application?
 131     bool m_grabbed;
 132 };
 133
 134 #endif // _WX_GTK_TOPLEVEL_H_