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 extern WXDLLEXPORT_DATA(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 (wxNO_BORDER)
  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 // Styles for RequestUserAttention
 108 enum
 109 {
 110     wxUSER_ATTENTION_INFO = 1,
 111     wxUSER_ATTENTION_ERROR = 2
 112 };
 113
 114 // ----------------------------------------------------------------------------
 115 // wxTopLevelWindow: a top level (as opposed to child) window
 116 // ----------------------------------------------------------------------------
 117
 118 class WXDLLEXPORT wxTopLevelWindowBase : public wxWindow
 119 {
 120 public:
 121     // construction
 122     wxTopLevelWindowBase();
 123     virtual ~wxTopLevelWindowBase();
 124
 125     // top level wnd state
 126     // --------------------
 127
 128     // maximize = true => maximize, otherwise - restore
 129     virtual void Maximize(bool maximize = true) = 0;
 130
 131     // undo Maximize() or Iconize()
 132     virtual void Restore() = 0;
 133
 134     // iconize = true => iconize, otherwise - restore
 135     virtual void Iconize(bool iconize = true) = 0;
 136
 137     // return true if the frame is maximized
 138     virtual bool IsMaximized() const = 0;
 139
 140     // return true if the frame is iconized
 141     virtual bool IsIconized() const = 0;
 142
 143     // get the frame icon
 144     const wxIcon& GetIcon() const { return m_icons.GetIcon( -1 ); }
 145
 146     // get the frame icons
 147     const wxIconBundle& GetIcons() const { return m_icons; }
 148
 149     // set the frame icon
 150     virtual void SetIcon(const wxIcon& icon) { m_icons = wxIconBundle( icon ); }
 151
 152     // set the frame icons
 153     virtual void SetIcons(const wxIconBundle& icons ) { m_icons = icons; }
 154
 155     // maximize the window to cover entire screen
 156     virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL) = 0;
 157
 158     // return true if the frame is in fullscreen mode
 159     virtual bool IsFullScreen() const = 0;
 160
 161     /*
 162        for now we already have them in wxWindow, but this is wrong: these
 163        methods really only make sense for wxTopLevelWindow!
 164
 165     virtual void SetTitle(const wxString& title) = 0;
 166     virtual wxString GetTitle() const = 0;
 167      */
 168
 169     // Set the shape of the window to the given region.
 170     // Returns true if the platform supports this feature (and the
 171     // operation is successful.)
 172     virtual bool SetShape(const wxRegion& WXUNUSED(region)) { return false; }
 173
 174     // Attracts the users attention to this window if the application is
 175     // inactive (should be called when a background event occurs)
 176     virtual void RequestUserAttention(int flags = wxUSER_ATTENTION_INFO);
 177
 178     // Is this the active frame (highlighted in the taskbar)?
 179     virtual bool IsActive()
 180         { return (wxGetTopLevelParent(FindFocus()) == this); }
 181
 182 #if defined(__SMARTPHONE__)
 183     virtual void SetLeftMenu(int id = wxID_ANY, const wxString& label = wxEmptyString, wxMenu *subMenu = NULL) = 0;
 184     virtual void SetRightMenu(int id = wxID_ANY, const wxString& label = wxEmptyString, wxMenu *subMenu = NULL) = 0;
 185 #endif // __SMARTPHONE__
 186
 187     // implementation only from now on
 188     // -------------------------------
 189
 190     // override some base class virtuals
 191     virtual bool Destroy();
 192     virtual bool IsTopLevel() const { return true; }
 193     virtual wxSize GetMaxSize() const;
 194     virtual bool ProvidesBackground() const { return true; }
 195
 196     // event handlers
 197     void OnCloseWindow(wxCloseEvent& event);
 198     void OnSize(wxSizeEvent& WXUNUSED(event)) { DoLayout(); }
 199
 200     // Get rect to be used to center top-level children
 201     virtual void GetRectForTopLevelChildren(int *x, int *y, int *w, int *h);
 202
 203     // this should go away, but for now it's called from docview.cpp,
 204     // so should be there for all platforms
 205     void OnActivate(wxActivateEvent &WXUNUSED(event)) { }
 206
 207     // do the window-specific processing after processing the update event
 208     virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ;
 209
 210 protected:
 211     // the frame client to screen translation should take account of the
 212     // toolbar which may shift the origin of the client area
 213     virtual void DoClientToScreen(int *x, int *y) const;
 214     virtual void DoScreenToClient(int *x, int *y) const;
 215
 216     // test whether this window makes part of the frame
 217     // (menubar, toolbar and statusbar are excluded from automatic layout)
 218     virtual bool IsOneOfBars(const wxWindow *WXUNUSED(win)) const
 219         { return false; }
 220
 221     // check if we should exit the program after deleting this top level
 222     // window (this is used in common dtor and wxMSW code)
 223     bool IsLastBeforeExit() const;
 224
 225     // send the iconize event, return true if processed
 226     bool SendIconizeEvent(bool iconized = true);
 227
 228     // do TLW-specific layout: we resize our unique child to fill the entire
 229     // client area
 230     void DoLayout();
 231
 232     // Get the default size for the new window if no explicit size given. If
 233     // there are better default sizes then these can be changed, just as long
 234     // as they are not too small for TLWs (and not larger than screen).
 235     static wxSize GetDefaultSize();
 236     static int WidthDefault(int w) { return w == wxDefaultCoord ? GetDefaultSize().x : w; }
 237     static int HeightDefault(int h) { return h == wxDefaultCoord ? GetDefaultSize().y : h; }
 238
 239     // the frame icon
 240     wxIconBundle m_icons;
 241
 242     DECLARE_NO_COPY_CLASS(wxTopLevelWindowBase)
 243     DECLARE_EVENT_TABLE()
 244 };
 245
 246
 247 // include the real class declaration
 248 #if defined(__WXPALMOS__)
 249     #include "wx/palmos/toplevel.h"
 250     #define wxTopLevelWindowNative wxTopLevelWindowPalm
 251 #elif defined(__WXMSW__)
 252     #include "wx/msw/toplevel.h"
 253     #define wxTopLevelWindowNative wxTopLevelWindowMSW
 254 #elif defined(__WXGTK__)
 255     #include "wx/gtk/toplevel.h"
 256     #define wxTopLevelWindowNative wxTopLevelWindowGTK
 257 #elif defined(__WXX11__)
 258     #include "wx/x11/toplevel.h"
 259     #define wxTopLevelWindowNative wxTopLevelWindowX11
 260 #elif defined(__WXMGL__)
 261     #include "wx/mgl/toplevel.h"
 262     #define wxTopLevelWindowNative wxTopLevelWindowMGL
 263 #elif defined(__WXMAC__)
 264     #include "wx/mac/toplevel.h"
 265     #define wxTopLevelWindowNative wxTopLevelWindowMac
 266 #elif defined(__WXCOCOA__)
 267     #include "wx/cocoa/toplevel.h"
 268     #define wxTopLevelWindowNative wxTopLevelWindowCocoa
 269 #elif defined(__WXPM__)
 270     #include "wx/os2/toplevel.h"
 271     #define wxTopLevelWindowNative wxTopLevelWindowOS2
 272 #elif defined(__WXMOTIF__)
 273     #include "wx/motif/toplevel.h"
 274     #define wxTopLevelWindowNative wxTopLevelWindowMotif
 275 #endif
 276
 277 #ifdef __WXUNIVERSAL__
 278     #include "wx/univ/toplevel.h"
 279 #else // !__WXUNIVERSAL__
 280     #ifdef wxTopLevelWindowNative
 281         class WXDLLEXPORT wxTopLevelWindow : public wxTopLevelWindowNative
 282         {
 283         public:
 284             // construction
 285             wxTopLevelWindow() { Init(); }
 286             wxTopLevelWindow(wxWindow *parent,
 287                        wxWindowID winid,
 288                        const wxString& title,
 289                        const wxPoint& pos = wxDefaultPosition,
 290                        const wxSize& size = wxDefaultSize,
 291                        long style = wxDEFAULT_FRAME_STYLE,
 292                        const wxString& name = wxFrameNameStr)
 293             {
 294                 Init();
 295                 Create(parent, winid, title, pos, size, style, name);
 296             }
 297
 298             DECLARE_DYNAMIC_CLASS_NO_COPY(wxTopLevelWindow)
 299         };
 300     #endif // wxTopLevelWindowNative
 301 #endif // __WXUNIVERSAL__/!__WXUNIVERSAL__
 302
 303
 304 #endif // _WX_TOPLEVEL_BASE_H_