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