include/wx/toplevel.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/toplevel.h
   3 // Purpose:     declares wxTopLevelWindow class, the base class for all
   4 //              top level windows (such as frames and dialogs)
   5 // Author:      Vadim Zeitlin, Vaclav Slavik
   6 // Modified by:
   7 // Created:     06.08.01
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
  10 //                       Vaclav Slavik <vaclav@wxwindows.org>
  11 // Licence:     wxWindows licence
  12 ///////////////////////////////////////////////////////////////////////////////
  13
  14 #ifndef _WX_TOPLEVEL_BASE_H_
  15 #define _WX_TOPLEVEL_BASE_H_
  16
  17 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  18     #pragma interface "toplevelbase.h"
  19 #endif
  20
  21 // ----------------------------------------------------------------------------
  22 // headers
  23 // ----------------------------------------------------------------------------
  24
  25 #include "wx/window.h"
  26 #include "wx/iconbndl.h"
  27
  28 // the default names for various classs
  29 WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr;
  30
  31 class WXDLLEXPORT wxTopLevelWindowBase;
  32
  33 // ----------------------------------------------------------------------------
  34 // constants
  35 // ----------------------------------------------------------------------------
  36
  37 // Dialogs are created in a special way
  38 #define wxTOPLEVEL_EX_DIALOG        0x00000008
  39
  40 // Styles for ShowFullScreen
  41 // (note that wxTopLevelWindow only handles wxFULLSCREEN_NOBORDER and
  42 //  wxFULLSCREEN_NOCAPTION; the rest is handled by wxTopLevelWindow)
  43 enum
  44 {
  45     wxFULLSCREEN_NOMENUBAR   = 0x0001,
  46     wxFULLSCREEN_NOTOOLBAR   = 0x0002,
  47     wxFULLSCREEN_NOSTATUSBAR = 0x0004,
  48     wxFULLSCREEN_NOBORDER    = 0x0008,
  49     wxFULLSCREEN_NOCAPTION   = 0x0010,
  50
  51     wxFULLSCREEN_ALL         = wxFULLSCREEN_NOMENUBAR | wxFULLSCREEN_NOTOOLBAR |
  52                                wxFULLSCREEN_NOSTATUSBAR | wxFULLSCREEN_NOBORDER |
  53                                wxFULLSCREEN_NOCAPTION
  54 };
  55
  56 // ----------------------------------------------------------------------------
  57 // wxTopLevelWindow: a top level (as opposed to child) window
  58 // ----------------------------------------------------------------------------
  59
  60 class WXDLLEXPORT wxTopLevelWindowBase : public wxWindow
  61 {
  62 public:
  63     // construction
  64     wxTopLevelWindowBase();
  65     virtual ~wxTopLevelWindowBase();
  66
  67     // top level wnd state
  68     // --------------------
  69
  70     // maximize = TRUE => maximize, otherwise - restore
  71     virtual void Maximize(bool maximize = TRUE) = 0;
  72
  73     // undo Maximize() or Iconize()
  74     virtual void Restore() = 0;
  75
  76     // iconize = TRUE => iconize, otherwise - restore
  77     virtual void Iconize(bool iconize = TRUE) = 0;
  78
  79     // return TRUE if the frame is maximized
  80     virtual bool IsMaximized() const = 0;
  81
  82     // return TRUE if the frame is iconized
  83     virtual bool IsIconized() const = 0;
  84
  85     // get the frame icon
  86     const wxIcon& GetIcon() const { return m_icons.GetIcon( -1 ); }
  87
  88     // get the frame icons
  89     const wxIconBundle& GetIcons() const { return m_icons; }
  90
  91     // set the frame icon
  92     virtual void SetIcon(const wxIcon& icon) { m_icons = wxIconBundle( icon ); }
  93
  94     // set the frame icons
  95     virtual void SetIcons(const wxIconBundle& icons ) { m_icons = icons; }
  96
  97     // maximize the window to cover entire screen
  98     virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL) = 0;
  99
 100     // return TRUE if the frame is in fullscreen mode
 101     virtual bool IsFullScreen() const = 0;
 102
 103     /*
 104        for now we already have them in wxWindow, but this is wrong: these
 105        methods really only make sense for wxTopLevelWindow!
 106
 107     virtual void SetTitle(const wxString& title) = 0;
 108     virtual wxString GetTitle() const = 0;
 109      */
 110
 111     // Set the shape of the window to the given region.
 112     // Returns TRUE if the platform supports this feature (and the
 113     // operation is successful.)
 114     virtual bool SetShape(const wxRegion& WXUNUSED(region)) { return FALSE; }
 115
 116     // implementation only from now on
 117     // -------------------------------
 118
 119     // override some base class virtuals
 120     virtual bool Destroy();
 121     virtual bool IsTopLevel() const { return TRUE; }
 122     virtual wxSize GetMaxSize() const;
 123
 124     // event handlers
 125     void OnCloseWindow(wxCloseEvent& event);
 126     void OnSize(wxSizeEvent& event);
 127
 128     // this should go away, but for now it's called from docview.cpp,
 129     // so should be there for all platforms
 130     void OnActivate(wxActivateEvent &WXUNUSED(event)) { }
 131
 132     // do the window-specific processing after processing the update event
 133     virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ;
 134
 135 protected:
 136     // the frame client to screen translation should take account of the
 137     // toolbar which may shift the origin of the client area
 138     virtual void DoClientToScreen(int *x, int *y) const;
 139     virtual void DoScreenToClient(int *x, int *y) const;
 140
 141     // test whether this window makes part of the frame
 142     // (menubar, toolbar and statusbar are excluded from automatic layout)
 143     virtual bool IsOneOfBars(const wxWindow *WXUNUSED(win)) const
 144         { return FALSE; }
 145
 146     // check if we should exit the program after deleting this top level
 147     // window (this is used in common dtor and wxMSW code)
 148     bool IsLastBeforeExit() const;
 149
 150     // send the iconize event, return TRUE if processed
 151     bool SendIconizeEvent(bool iconized = TRUE);
 152
 153     // Get the default size for the new window if no explicit size given. If
 154     // there are better default sizes then these can be changed, just as long
 155     // as they are not too small for TLWs.
 156     static int WidthDefault(int w) { return w == -1 ? 400 : w; }
 157     static int HeightDefault(int h) { return h == -1 ? 250 : h; }
 158
 159     // the frame icon
 160     wxIconBundle m_icons;
 161
 162     DECLARE_NO_COPY_CLASS(wxTopLevelWindowBase)
 163     DECLARE_EVENT_TABLE()
 164 };
 165
 166
 167 // include the real class declaration
 168 #if defined(__WXMSW__)
 169     #include "wx/msw/toplevel.h"
 170     #define wxTopLevelWindowNative wxTopLevelWindowMSW
 171 #elif defined(__WXGTK__)
 172     #include "wx/gtk/toplevel.h"
 173     #define wxTopLevelWindowNative wxTopLevelWindowGTK
 174 #elif defined(__WXX11__)
 175     #include "wx/x11/toplevel.h"
 176     #define wxTopLevelWindowNative wxTopLevelWindowX11
 177 #elif defined(__WXMGL__)
 178     #include "wx/mgl/toplevel.h"
 179     #define wxTopLevelWindowNative wxTopLevelWindowMGL
 180 #elif defined(__WXMAC__)
 181     #include "wx/mac/toplevel.h"
 182     #define wxTopLevelWindowNative wxTopLevelWindowMac
 183 #elif defined(__WXCOCOA__)
 184     #include "wx/cocoa/toplevel.h"
 185     #define wxTopLevelWindowNative wxTopLevelWindowCocoa
 186 #elif defined(__WXPM__)
 187     #include "wx/os2/toplevel.h"
 188     #define wxTopLevelWindowNative wxTopLevelWindowOS2
 189 #elif defined(__WXMOTIF__)
 190     #include "wx/motif/toplevel.h"
 191     #define wxTopLevelWindowNative wxTopLevelWindowMotif
 192 #endif
 193
 194 #ifdef __WXUNIVERSAL__
 195     #include "wx/univ/toplevel.h"
 196 #else // !__WXUNIVERSAL__
 197     #ifdef wxTopLevelWindowNative
 198         class WXDLLEXPORT wxTopLevelWindow : public wxTopLevelWindowNative
 199         {
 200         public:
 201             // construction
 202             wxTopLevelWindow() { Init(); }
 203             wxTopLevelWindow(wxWindow *parent,
 204                        wxWindowID winid,
 205                        const wxString& title,
 206                        const wxPoint& pos = wxDefaultPosition,
 207                        const wxSize& size = wxDefaultSize,
 208                        long style = wxDEFAULT_FRAME_STYLE,
 209                        const wxString& name = wxFrameNameStr)
 210             {
 211                 Init();
 212                 Create(parent, winid, title, pos, size, style, name);
 213             }
 214
 215             DECLARE_DYNAMIC_CLASS_NO_COPY(wxTopLevelWindow)
 216         };
 217     #endif // wxTopLevelWindowNative
 218 #endif // __WXUNIVERSAL__/!__WXUNIVERSAL__
 219
 220
 221 #endif // _WX_TOPLEVEL_BASE_H_