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@wxwidgets.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 // style common to both wxFrame and wxDialog
  38 #define wxSTAY_ON_TOP           0x8000
  39 #define wxICONIZE               0x4000
  40 #define wxMINIMIZE              wxICONIZE
  41 #define wxMAXIMIZE              0x2000
  42 #define wxCLOSE_BOX             0x1000
  43
  44 #define wxSYSTEM_MENU           0x0800
  45 #define wxMINIMIZE_BOX          0x0400
  46 #define wxMAXIMIZE_BOX          0x0200
  47 #define wxTINY_CAPTION_HORIZ    0x0100
  48 #define wxTINY_CAPTION_VERT     0x0080
  49 #define wxRESIZE_BORDER         0x0040
  50
  51 // deprecated versions defined for compatibility reasons
  52 #define wxRESIZE_BOX            wxMAXIMIZE_BOX
  53 #define wxTHICK_FRAME           wxRESIZE_BORDER
  54
  55 // obsolete styles, unused any more
  56 #define wxDIALOG_MODAL          0
  57 #define wxDIALOG_MODELESS       0
  58 #define wxNO_3D                 0
  59 #define wxUSER_COLOURS          0
  60
  61 // default style
  62 //
  63 // under Windows CE (at least when compiling with eVC 4) we should create
  64 // top level windows without any styles at all for them to appear
  65 // "correctly", i.e. as full screen windows with a "hide" button (same as
  66 // "close" but round instead of squared and just hides the applications
  67 // instead of closing it) in the title bar
  68 #if defined(__WXWINCE__)
  69         #if defined(__SMARTPHONE__)
  70                 #define wxDEFAULT_FRAME_STYLE (wxMAXIMIZE)
  71     #elif defined(__WINCE_STANDARDSDK__)
  72                 #define wxDEFAULT_FRAME_STYLE (wxMAXIMIZE|wxCLOSE_BOX)
  73         #else
  74                 #define wxDEFAULT_FRAME_STYLE (0)
  75         #endif
  76 #else // !__WXWINCE__
  77     #define wxDEFAULT_FRAME_STYLE \
  78             (wxSYSTEM_MENU | \
  79              wxRESIZE_BORDER | \
  80              wxMINIMIZE_BOX | \
  81              wxMAXIMIZE_BOX | \
  82              wxCLOSE_BOX | \
  83              wxCAPTION | \
  84              wxCLIP_CHILDREN)
  85 #endif
  86
  87
  88 // Dialogs are created in a special way
  89 #define wxTOPLEVEL_EX_DIALOG        0x00000008
  90
  91 // Styles for ShowFullScreen
  92 // (note that wxTopLevelWindow only handles wxFULLSCREEN_NOBORDER and
  93 //  wxFULLSCREEN_NOCAPTION; the rest is handled by wxTopLevelWindow)
  94 enum
  95 {
  96     wxFULLSCREEN_NOMENUBAR   = 0x0001,
  97     wxFULLSCREEN_NOTOOLBAR   = 0x0002,
  98     wxFULLSCREEN_NOSTATUSBAR = 0x0004,
  99     wxFULLSCREEN_NOBORDER    = 0x0008,
 100     wxFULLSCREEN_NOCAPTION   = 0x0010,
 101
 102     wxFULLSCREEN_ALL         = wxFULLSCREEN_NOMENUBAR | wxFULLSCREEN_NOTOOLBAR |
 103                                wxFULLSCREEN_NOSTATUSBAR | wxFULLSCREEN_NOBORDER |
 104                                wxFULLSCREEN_NOCAPTION
 105 };
 106
 107 // ----------------------------------------------------------------------------
 108 // wxTopLevelWindow: a top level (as opposed to child) window
 109 // ----------------------------------------------------------------------------
 110
 111 class WXDLLEXPORT wxTopLevelWindowBase : public wxWindow
 112 {
 113 public:
 114     // construction
 115     wxTopLevelWindowBase();
 116     virtual ~wxTopLevelWindowBase();
 117
 118     // top level wnd state
 119     // --------------------
 120
 121     // maximize = TRUE => maximize, otherwise - restore
 122     virtual void Maximize(bool maximize = TRUE) = 0;
 123
 124     // undo Maximize() or Iconize()
 125     virtual void Restore() = 0;
 126
 127     // iconize = TRUE => iconize, otherwise - restore
 128     virtual void Iconize(bool iconize = TRUE) = 0;
 129
 130     // return TRUE if the frame is maximized
 131     virtual bool IsMaximized() const = 0;
 132
 133     // return TRUE if the frame is iconized
 134     virtual bool IsIconized() const = 0;
 135
 136     // get the frame icon
 137     const wxIcon& GetIcon() const { return m_icons.GetIcon( -1 ); }
 138
 139     // get the frame icons
 140     const wxIconBundle& GetIcons() const { return m_icons; }
 141
 142     // set the frame icon
 143     virtual void SetIcon(const wxIcon& icon) { m_icons = wxIconBundle( icon ); }
 144
 145     // set the frame icons
 146     virtual void SetIcons(const wxIconBundle& icons ) { m_icons = icons; }
 147
 148     // maximize the window to cover entire screen
 149     virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL) = 0;
 150
 151     // return TRUE if the frame is in fullscreen mode
 152     virtual bool IsFullScreen() const = 0;
 153
 154     /*
 155        for now we already have them in wxWindow, but this is wrong: these
 156        methods really only make sense for wxTopLevelWindow!
 157
 158     virtual void SetTitle(const wxString& title) = 0;
 159     virtual wxString GetTitle() const = 0;
 160      */
 161
 162     // Set the shape of the window to the given region.
 163     // Returns TRUE if the platform supports this feature (and the
 164     // operation is successful.)
 165     virtual bool SetShape(const wxRegion& WXUNUSED(region)) { return FALSE; }
 166
 167     // implementation only from now on
 168     // -------------------------------
 169
 170     // override some base class virtuals
 171     virtual bool Destroy();
 172     virtual bool IsTopLevel() const { return TRUE; }
 173     virtual wxSize GetMaxSize() const;
 174
 175     // event handlers
 176     void OnCloseWindow(wxCloseEvent& event);
 177     void OnSize(wxSizeEvent& event);
 178
 179     // this should go away, but for now it's called from docview.cpp,
 180     // so should be there for all platforms
 181     void OnActivate(wxActivateEvent &WXUNUSED(event)) { }
 182
 183     // do the window-specific processing after processing the update event
 184     virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ;
 185
 186 protected:
 187     // the frame client to screen translation should take account of the
 188     // toolbar which may shift the origin of the client area
 189     virtual void DoClientToScreen(int *x, int *y) const;
 190     virtual void DoScreenToClient(int *x, int *y) const;
 191
 192     // test whether this window makes part of the frame
 193     // (menubar, toolbar and statusbar are excluded from automatic layout)
 194     virtual bool IsOneOfBars(const wxWindow *WXUNUSED(win)) const
 195         { return FALSE; }
 196
 197     // check if we should exit the program after deleting this top level
 198     // window (this is used in common dtor and wxMSW code)
 199     bool IsLastBeforeExit() const;
 200
 201     // send the iconize event, return TRUE if processed
 202     bool SendIconizeEvent(bool iconized = TRUE);
 203
 204     // Get the default size for the new window if no explicit size given. If
 205     // there are better default sizes then these can be changed, just as long
 206     // as they are not too small for TLWs (and not larger than screen).
 207     static wxSize GetDefaultSize();
 208     static int WidthDefault(int w) { return w == -1 ? GetDefaultSize().x : w; }
 209     static int HeightDefault(int h) { return h == -1 ? GetDefaultSize().y : h; }
 210
 211     // the frame icon
 212     wxIconBundle m_icons;
 213
 214     DECLARE_NO_COPY_CLASS(wxTopLevelWindowBase)
 215     DECLARE_EVENT_TABLE()
 216 };
 217
 218
 219 // include the real class declaration
 220 #if defined(__WXMSW__)
 221     #include "wx/msw/toplevel.h"
 222     #define wxTopLevelWindowNative wxTopLevelWindowMSW
 223 #elif defined(__WXGTK__)
 224     #include "wx/gtk/toplevel.h"
 225     #define wxTopLevelWindowNative wxTopLevelWindowGTK
 226 #elif defined(__WXX11__)
 227     #include "wx/x11/toplevel.h"
 228     #define wxTopLevelWindowNative wxTopLevelWindowX11
 229 #elif defined(__WXMGL__)
 230     #include "wx/mgl/toplevel.h"
 231     #define wxTopLevelWindowNative wxTopLevelWindowMGL
 232 #elif defined(__WXMAC__)
 233     #include "wx/mac/toplevel.h"
 234     #define wxTopLevelWindowNative wxTopLevelWindowMac
 235 #elif defined(__WXCOCOA__)
 236     #include "wx/cocoa/toplevel.h"
 237     #define wxTopLevelWindowNative wxTopLevelWindowCocoa
 238 #elif defined(__WXPM__)
 239     #include "wx/os2/toplevel.h"
 240     #define wxTopLevelWindowNative wxTopLevelWindowOS2
 241 #elif defined(__WXMOTIF__)
 242     #include "wx/motif/toplevel.h"
 243     #define wxTopLevelWindowNative wxTopLevelWindowMotif
 244 #endif
 245
 246 #ifdef __WXUNIVERSAL__
 247     #include "wx/univ/toplevel.h"
 248 #else // !__WXUNIVERSAL__
 249     #ifdef wxTopLevelWindowNative
 250         class WXDLLEXPORT wxTopLevelWindow : public wxTopLevelWindowNative
 251         {
 252         public:
 253             // construction
 254             wxTopLevelWindow() { Init(); }
 255             wxTopLevelWindow(wxWindow *parent,
 256                        wxWindowID winid,
 257                        const wxString& title,
 258                        const wxPoint& pos = wxDefaultPosition,
 259                        const wxSize& size = wxDefaultSize,
 260                        long style = wxDEFAULT_FRAME_STYLE,
 261                        const wxString& name = wxFrameNameStr)
 262             {
 263                 Init();
 264                 Create(parent, winid, title, pos, size, style, name);
 265             }
 266
 267             DECLARE_DYNAMIC_CLASS_NO_COPY(wxTopLevelWindow)
 268         };
 269     #endif // wxTopLevelWindowNative
 270 #endif // __WXUNIVERSAL__/!__WXUNIVERSAL__
 271
 272
 273 #endif // _WX_TOPLEVEL_BASE_H_