3c81c9aafb
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@38071 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
326 lines
12 KiB
C++
326 lines
12 KiB
C++
///////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/toplevel.h
|
|
// Purpose: declares wxTopLevelWindow class, the base class for all
|
|
// top level windows (such as frames and dialogs)
|
|
// Author: Vadim Zeitlin, Vaclav Slavik
|
|
// Modified by:
|
|
// Created: 06.08.01
|
|
// RCS-ID: $Id$
|
|
// Copyright: (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
|
|
// Vaclav Slavik <vaclav@wxwidgets.org>
|
|
// Licence: wxWindows licence
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _WX_TOPLEVEL_BASE_H_
|
|
#define _WX_TOPLEVEL_BASE_H_
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// headers
|
|
// ----------------------------------------------------------------------------
|
|
|
|
#include "wx/window.h"
|
|
#include "wx/iconbndl.h"
|
|
|
|
// the default names for various classes
|
|
extern WXDLLEXPORT_DATA(const wxChar) wxFrameNameStr[];
|
|
|
|
class WXDLLEXPORT wxTopLevelWindowBase;
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// constants
|
|
// ----------------------------------------------------------------------------
|
|
|
|
// style common to both wxFrame and wxDialog
|
|
#define wxSTAY_ON_TOP 0x8000
|
|
#define wxICONIZE 0x4000
|
|
#define wxMINIMIZE wxICONIZE
|
|
#define wxMAXIMIZE 0x2000
|
|
#define wxCLOSE_BOX 0x1000
|
|
|
|
#define wxSYSTEM_MENU 0x0800
|
|
#define wxMINIMIZE_BOX 0x0400
|
|
#define wxMAXIMIZE_BOX 0x0200
|
|
#define wxTINY_CAPTION_HORIZ 0x0100
|
|
#define wxTINY_CAPTION_VERT 0x0080
|
|
#define wxRESIZE_BORDER 0x0040
|
|
|
|
// deprecated versions defined for compatibility reasons
|
|
#define wxRESIZE_BOX wxMAXIMIZE_BOX
|
|
#define wxTHICK_FRAME wxRESIZE_BORDER
|
|
|
|
// obsolete styles, unused any more
|
|
#define wxDIALOG_MODAL 0
|
|
#define wxDIALOG_MODELESS 0
|
|
#define wxNO_3D 0
|
|
#define wxUSER_COLOURS 0
|
|
|
|
// default style
|
|
//
|
|
// under Windows CE (at least when compiling with eVC 4) we should create
|
|
// top level windows without any styles at all for them to appear
|
|
// "correctly", i.e. as full screen windows with a "hide" button (same as
|
|
// "close" but round instead of squared and just hides the applications
|
|
// instead of closing it) in the title bar
|
|
#if defined(__WXWINCE__)
|
|
#if defined(__SMARTPHONE__)
|
|
#define wxDEFAULT_FRAME_STYLE (wxMAXIMIZE)
|
|
#elif defined(__WINCE_STANDARDSDK__)
|
|
#define wxDEFAULT_FRAME_STYLE (wxMAXIMIZE|wxCLOSE_BOX)
|
|
#else
|
|
#define wxDEFAULT_FRAME_STYLE (wxNO_BORDER)
|
|
#endif
|
|
#else // !__WXWINCE__
|
|
#define wxDEFAULT_FRAME_STYLE \
|
|
(wxSYSTEM_MENU | \
|
|
wxRESIZE_BORDER | \
|
|
wxMINIMIZE_BOX | \
|
|
wxMAXIMIZE_BOX | \
|
|
wxCLOSE_BOX | \
|
|
wxCAPTION | \
|
|
wxCLIP_CHILDREN)
|
|
#endif
|
|
|
|
|
|
// Dialogs are created in a special way
|
|
#define wxTOPLEVEL_EX_DIALOG 0x00000008
|
|
|
|
// Styles for ShowFullScreen
|
|
// (note that wxTopLevelWindow only handles wxFULLSCREEN_NOBORDER and
|
|
// wxFULLSCREEN_NOCAPTION; the rest is handled by wxTopLevelWindow)
|
|
enum
|
|
{
|
|
wxFULLSCREEN_NOMENUBAR = 0x0001,
|
|
wxFULLSCREEN_NOTOOLBAR = 0x0002,
|
|
wxFULLSCREEN_NOSTATUSBAR = 0x0004,
|
|
wxFULLSCREEN_NOBORDER = 0x0008,
|
|
wxFULLSCREEN_NOCAPTION = 0x0010,
|
|
|
|
wxFULLSCREEN_ALL = wxFULLSCREEN_NOMENUBAR | wxFULLSCREEN_NOTOOLBAR |
|
|
wxFULLSCREEN_NOSTATUSBAR | wxFULLSCREEN_NOBORDER |
|
|
wxFULLSCREEN_NOCAPTION
|
|
};
|
|
|
|
// Styles for RequestUserAttention
|
|
enum
|
|
{
|
|
wxUSER_ATTENTION_INFO = 1,
|
|
wxUSER_ATTENTION_ERROR = 2
|
|
};
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// wxTopLevelWindow: a top level (as opposed to child) window
|
|
// ----------------------------------------------------------------------------
|
|
|
|
class WXDLLEXPORT wxTopLevelWindowBase : public wxWindow
|
|
{
|
|
public:
|
|
// construction
|
|
wxTopLevelWindowBase();
|
|
virtual ~wxTopLevelWindowBase();
|
|
|
|
// top level wnd state
|
|
// --------------------
|
|
|
|
// maximize = true => maximize, otherwise - restore
|
|
virtual void Maximize(bool maximize = true) = 0;
|
|
|
|
// undo Maximize() or Iconize()
|
|
virtual void Restore() = 0;
|
|
|
|
// iconize = true => iconize, otherwise - restore
|
|
virtual void Iconize(bool iconize = true) = 0;
|
|
|
|
// return true if the frame is maximized
|
|
virtual bool IsMaximized() const = 0;
|
|
|
|
// return true if the frame is iconized
|
|
virtual bool IsIconized() const = 0;
|
|
|
|
// get the frame icon
|
|
const wxIcon& GetIcon() const { return m_icons.GetIcon( -1 ); }
|
|
|
|
// get the frame icons
|
|
const wxIconBundle& GetIcons() const { return m_icons; }
|
|
|
|
// set the frame icon
|
|
virtual void SetIcon(const wxIcon& icon) { m_icons = wxIconBundle( icon ); }
|
|
|
|
// set the frame icons
|
|
virtual void SetIcons(const wxIconBundle& icons ) { m_icons = icons; }
|
|
|
|
// maximize the window to cover entire screen
|
|
virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL) = 0;
|
|
|
|
// return true if the frame is in fullscreen mode
|
|
virtual bool IsFullScreen() const = 0;
|
|
|
|
// the title of the top level window: the text which the
|
|
// window shows usually at the top of the frame/dialog in dedicated bar
|
|
virtual void SetTitle(const wxString& title) = 0;
|
|
virtual wxString GetTitle() const = 0;
|
|
|
|
// Set the shape of the window to the given region.
|
|
// Returns true if the platform supports this feature (and the
|
|
// operation is successful.)
|
|
virtual bool SetShape(const wxRegion& WXUNUSED(region)) { return false; }
|
|
|
|
// Attracts the users attention to this window if the application is
|
|
// inactive (should be called when a background event occurs)
|
|
virtual void RequestUserAttention(int flags = wxUSER_ATTENTION_INFO);
|
|
|
|
// Is this the active frame (highlighted in the taskbar)?
|
|
virtual bool IsActive()
|
|
{ return (wxGetTopLevelParent(FindFocus()) == this); }
|
|
|
|
#if defined(__SMARTPHONE__)
|
|
virtual void SetLeftMenu(int id = wxID_ANY, const wxString& label = wxEmptyString, wxMenu *subMenu = NULL) = 0;
|
|
virtual void SetRightMenu(int id = wxID_ANY, const wxString& label = wxEmptyString, wxMenu *subMenu = NULL) = 0;
|
|
#endif // __SMARTPHONE__
|
|
|
|
// centre the window on screen: this is just a shortcut
|
|
void CentreOnScreen(int dir = wxBOTH) { DoCentre(dir | wxCENTRE_ON_SCREEN); }
|
|
void CenterOnScreen(int dir = wxBOTH) { CentreOnScreen(dir); }
|
|
|
|
|
|
// implementation only from now on
|
|
// -------------------------------
|
|
|
|
// override some base class virtuals
|
|
virtual bool Destroy();
|
|
virtual bool IsTopLevel() const { return true; }
|
|
virtual wxSize GetMaxSize() const;
|
|
|
|
// event handlers
|
|
void OnCloseWindow(wxCloseEvent& event);
|
|
void OnSize(wxSizeEvent& WXUNUSED(event)) { DoLayout(); }
|
|
|
|
// Get rect to be used to center top-level children
|
|
virtual void GetRectForTopLevelChildren(int *x, int *y, int *w, int *h);
|
|
|
|
// this should go away, but for now it's called from docview.cpp,
|
|
// so should be there for all platforms
|
|
void OnActivate(wxActivateEvent &WXUNUSED(event)) { }
|
|
|
|
// do the window-specific processing after processing the update event
|
|
virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ;
|
|
|
|
// Reserved for future use
|
|
virtual void ReservedTopLevelWindowFunc1() {}
|
|
virtual void ReservedTopLevelWindowFunc2() {}
|
|
virtual void ReservedTopLevelWindowFunc3() {}
|
|
virtual void ReservedTopLevelWindowFunc4() {}
|
|
virtual void ReservedTopLevelWindowFunc5() {}
|
|
virtual void ReservedTopLevelWindowFunc6() {}
|
|
virtual void ReservedTopLevelWindowFunc7() {}
|
|
virtual void ReservedTopLevelWindowFunc8() {}
|
|
virtual void ReservedTopLevelWindowFunc9() {}
|
|
|
|
protected:
|
|
// the frame client to screen translation should take account of the
|
|
// toolbar which may shift the origin of the client area
|
|
virtual void DoClientToScreen(int *x, int *y) const;
|
|
virtual void DoScreenToClient(int *x, int *y) const;
|
|
|
|
// add support for wxCENTRE_ON_SCREEN
|
|
virtual void DoCentre(int dir);
|
|
|
|
// no need to do client to screen translation to get our position in screen
|
|
// coordinates: this is already the case
|
|
virtual void DoGetScreenPosition(int *x, int *y) const
|
|
{
|
|
return DoGetPosition(x, y);
|
|
}
|
|
|
|
// test whether this window makes part of the frame
|
|
// (menubar, toolbar and statusbar are excluded from automatic layout)
|
|
virtual bool IsOneOfBars(const wxWindow *WXUNUSED(win)) const
|
|
{ return false; }
|
|
|
|
// check if we should exit the program after deleting this top level
|
|
// window (this is used in common dtor and wxMSW code)
|
|
bool IsLastBeforeExit() const;
|
|
|
|
// send the iconize event, return true if processed
|
|
bool SendIconizeEvent(bool iconized = true);
|
|
|
|
// do TLW-specific layout: we resize our unique child to fill the entire
|
|
// client area
|
|
void DoLayout();
|
|
|
|
// Get the default size for the new window if no explicit size given. If
|
|
// there are better default sizes then these can be changed, just as long
|
|
// as they are not too small for TLWs (and not larger than screen).
|
|
static wxSize GetDefaultSize();
|
|
static int WidthDefault(int w) { return w == wxDefaultCoord ? GetDefaultSize().x : w; }
|
|
static int HeightDefault(int h) { return h == wxDefaultCoord ? GetDefaultSize().y : h; }
|
|
|
|
// the frame icon
|
|
wxIconBundle m_icons;
|
|
|
|
DECLARE_NO_COPY_CLASS(wxTopLevelWindowBase)
|
|
DECLARE_EVENT_TABLE()
|
|
};
|
|
|
|
|
|
// include the real class declaration
|
|
#if defined(__WXPALMOS__)
|
|
#include "wx/palmos/toplevel.h"
|
|
#define wxTopLevelWindowNative wxTopLevelWindowPalm
|
|
#elif defined(__WXMSW__)
|
|
#include "wx/msw/toplevel.h"
|
|
#define wxTopLevelWindowNative wxTopLevelWindowMSW
|
|
#elif defined(__WXGTK20__)
|
|
#include "wx/gtk/toplevel.h"
|
|
#define wxTopLevelWindowNative wxTopLevelWindowGTK
|
|
#elif defined(__WXGTK__)
|
|
#include "wx/gtk1/toplevel.h"
|
|
#define wxTopLevelWindowNative wxTopLevelWindowGTK
|
|
#elif defined(__WXX11__)
|
|
#include "wx/x11/toplevel.h"
|
|
#define wxTopLevelWindowNative wxTopLevelWindowX11
|
|
#elif defined(__WXMGL__)
|
|
#include "wx/mgl/toplevel.h"
|
|
#define wxTopLevelWindowNative wxTopLevelWindowMGL
|
|
#elif defined(__WXMAC__)
|
|
#include "wx/mac/toplevel.h"
|
|
#define wxTopLevelWindowNative wxTopLevelWindowMac
|
|
#elif defined(__WXCOCOA__)
|
|
#include "wx/cocoa/toplevel.h"
|
|
#define wxTopLevelWindowNative wxTopLevelWindowCocoa
|
|
#elif defined(__WXPM__)
|
|
#include "wx/os2/toplevel.h"
|
|
#define wxTopLevelWindowNative wxTopLevelWindowOS2
|
|
#elif defined(__WXMOTIF__)
|
|
#include "wx/motif/toplevel.h"
|
|
#define wxTopLevelWindowNative wxTopLevelWindowMotif
|
|
#endif
|
|
|
|
#ifdef __WXUNIVERSAL__
|
|
#include "wx/univ/toplevel.h"
|
|
#else // !__WXUNIVERSAL__
|
|
#ifdef wxTopLevelWindowNative
|
|
class WXDLLEXPORT wxTopLevelWindow : public wxTopLevelWindowNative
|
|
{
|
|
public:
|
|
// construction
|
|
wxTopLevelWindow() { Init(); }
|
|
wxTopLevelWindow(wxWindow *parent,
|
|
wxWindowID winid,
|
|
const wxString& title,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long style = wxDEFAULT_FRAME_STYLE,
|
|
const wxString& name = wxFrameNameStr)
|
|
{
|
|
Init();
|
|
Create(parent, winid, title, pos, size, style, name);
|
|
}
|
|
|
|
DECLARE_DYNAMIC_CLASS_NO_COPY(wxTopLevelWindow)
|
|
};
|
|
#endif // wxTopLevelWindowNative
|
|
#endif // __WXUNIVERSAL__/!__WXUNIVERSAL__
|
|
|
|
|
|
#endif // _WX_TOPLEVEL_BASE_H_
|