directly, but all of its methods are also applicable for the two classes
above.
+ Note that the instances of wxTopLevelWindow are managed by wxWidgets in the
+ internal top level window list.
+
+ @beginEventEmissionTable
+ @event{EVT_ACTIVATE(id, func)}
+ Process a @c wxEVT_MAXIMIZE event. See wxMaximizeEvent.
+ @event{EVT_MOVE(func)}
+ Process a @c wxEVT_MOVE event, which is generated when a window is moved.
+ See wxMoveEvent.
+ @event{EVT_MOVE_START(func)}
+ Process a @c wxEVT_MOVE_START event, which is generated when the user starts
+ to move or size a window. wxMSW only.
+ See wxMoveEvent.
+ @event{EVT_MOVE_END(func)}
+ Process a @c wxEVT_MOVE_END event, which is generated when the user stops
+ moving or sizing a window. wxMSW only.
+ See wxMoveEvent.
+ @endEventTable
+
@library{wxcore}
@category{managedwnd}
class wxTopLevelWindow : public wxWindow
{
public:
+ /**
+ Default ctor.
+ */
+ wxTopLevelWindow();
+
+ /**
+ Constructor creating the top level window.
+ */
+ 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);
+
+ /**
+ Destructor. Remember that wxTopLevelWindows do not get immediately
+ destroyed when the user (or the app) closes them; they have a
+ @b delayed destruction.
+
+ See @ref overview_windowdeletion for more info.
+ */
+ virtual ~wxTopLevelWindow();
+
+ /**
+ Creates the top level window.
+ */
+ bool Create(wxWindow *parent,
+ wxWindowID id,
+ const wxString& title,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = wxDEFAULT_FRAME_STYLE,
+ const wxString& name = wxFrameNameStr);
+
/**
Returns @true if the platform supports making the window translucent.
(including GTK+) where the window manager may not support this operation
and there is no way to find out.
*/
- bool EnableCloseButton(bool enable = true);
+ virtual bool EnableCloseButton(bool enable = true);
/**
Returns a pointer to the button which is the default for this window, or
@see GetIcons()
*/
- const wxIcon GetIcon() const;
+ wxIcon GetIcon() const;
/**
Returns all icons associated with the window, there will be none of them
@see wxIconBundle
*/
- const wxIconBundle GetIcons() const;
+ const wxIconBundle& GetIcons() const;
/**
Gets a string containing the window title.
@see SetTitle()
*/
- wxString GetTitle() const;
+ virtual wxString GetTitle() const;
/**
Unique to the wxWinCE port. Responds to showing/hiding SIP (soft input
@see IsIconized(), Maximize(), wxIconizeEvent.
*/
- void Iconize(bool iconize);
+ virtual void Iconize(bool iconize = true);
/**
Returns @true if this window is currently active, i.e. if the user is
@see ShowFullScreen()
*/
- bool IsFullScreen();
+ virtual bool IsFullScreen() const;
/**
Returns @true if the window is iconized.
*/
- bool IsIconized() const;
+ virtual bool IsIconized() const;
/**
Returns @true if the window is maximized.
*/
- bool IsMaximized() const;
+ virtual bool IsMaximized() const;
/**
This method is specific to wxUniversal port.
*/
bool IsUsingNativeDecorations() const;
+ /**
+ See wxWindow::SetAutoLayout(): when auto layout is on, this function gets
+ called automatically when the window is resized.
+ */
+ virtual bool Layout();
+
/**
Maximizes or restores the window.
@see Iconize()
*/
- void Maximize(bool maximize);
+ virtual void Maximize(bool maximize = true);
/**
Use a system-dependent way to attract users attention to the window when
@see GetDefaultItem()
*/
- void SetDefaultItem(wxWindow* win);
+ wxWindow* SetDefaultItem(wxWindow* win);
/**
Sets the icon for this window.
reference counting, the copy is very quick. It is safe to
delete @a icon after calling this function.
- @see wxIcon
+ @note In wxMSW, @a icon must be either 16x16 or 32x32 icon.
+
+ @see wxIcon, SetIcons()
*/
void SetIcon(const wxIcon& icon);
@param icons
The icons to associate with this window.
- @see wxIconBundle.
+ @note In wxMSW, @a icons must contain a 16x16 or 32x32 icon,
+ preferably both.
+
+ @see wxIconBundle
*/
virtual void SetIcons(const wxIconBundle& icons);
Identifier for this button.
@param label
Text to be displayed on the screen area dedicated to this hardware
- button.
+ button.
@param subMenu
The menu to be opened after pressing this hardware button.
size increments. If a pair of values is not set (or set to -1), no
constraints will be used.
+ @param minW
+ The minimum width.
+ @param minH
+ The minimum height.
+ @param maxW
+ The maximum width.
+ @param maxH
+ The maximum height.
@param incW
Specifies the increment for sizing the width (GTK/Motif/Xt only).
@param incH
wxWindow::SetSize().
*/
- virtual void SetSizeHints(int minW, int minH, int maxW = -1,
- int maxH = -1,
- int incW = -1,
- int incH = -1);
+ virtual void SetSizeHints(int minW, int minH,
+ int maxW = -1, int maxH = -1,
+ int incW = -1, int incH = -1);
/**
Allows specification of minimum and maximum window sizes, and window
size increments. If a pair of values is not set (or set to -1), no
constraints will be used.
+ @param minSize
+ The minimum size of the window.
+ @param maxSize
+ The maximum size of the window.
@param incSize
Increment size (only taken into account under X11-based ports such
as wxGTK/wxMotif/wxX11).
fully transparent, and a value of 255 sets the window to be fully
opaque.
*/
- virtual bool SetTransparent(int alpha);
+ virtual bool SetTransparent(wxByte alpha);
/**
This virtual function is not meant to be called directly but can be
there are any open top level windows.
*/
virtual bool ShouldPreventAppExit() const;
+
+ /**
+ This function sets the wxTopLevelWindow's modified state on OS X,
+ which currently draws a black dot in the wxTopLevelWindow's close button.
+ On other platforms, this method does nothing.
+
+ @see OSXIsModified()
+ */
+ virtual void OSXSetModified(bool modified);
+
+ /**
+ Returns the current modified state of the wxTopLevelWindow on OS X.
+ On other platforms, this method does nothing.
+
+ @see OSXSetModified()
+ */
+ virtual bool OSXIsModified() const;
/**
Depending on the value of @a show parameter the window is either shown
@see IsFullScreen()
*/
- bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL);
+ virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL);
/**
This method is specific to wxUniversal port.
decorations are used by default and so it may make sense to call this
method with default argument if the application can't use custom
decorations at all for some reason.
-
+
@see UseNativeDecorations()
*/
void UseNativeDecorationsByDefault(bool native = true);
projects / wxWidgets.git / blobdiff