/////////////////////////////////////////////////////////////////////////////
// Name: toplevel.h
-// Purpose: documentation for wxTopLevelWindow class
+// Purpose: interface of wxTopLevelWindow
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@library{wxcore}
@category{managedwnd}
- @seealso
- wxTopLevelWindow::SetTransparent
+ @see wxTopLevelWindow::SetTransparent
*/
class wxTopLevelWindow : public wxWindow
{
public:
/**
Returns @true if the platform supports making the window translucent.
-
+
@see SetTransparent()
*/
virtual bool CanSetTransparent();
/**
Centres the window on screen.
-
+
@param direction
Specifies the direction for the centering. May be wxHORIZONTAL, wxVERTICAL
or wxBOTH.
-
+
@see wxWindow::CentreOnParent
*/
void CentreOnScreen(int direction = wxBOTH);
@NULL.
The default button is the one activated by pressing the Enter key.
*/
- wxWindow* GetDefaultItem();
+ wxWindow* GetDefaultItem() const;
/**
Returns the standard icon of the window. The icon will be invalid if it hadn't
been previously set by SetIcon().
-
+
@see GetIcons()
*/
- const wxIcon GetIcon();
+ const wxIcon GetIcon() const;
/**
Returns all icons associated with the window, there will be none of them if
SetIcons() had been called before.
Use GetIcon() to get the main icon of the
window.
-
+
@see wxIconBundle
*/
- const wxIconBundle GetIcons();
+ const wxIconBundle GetIcons() const;
/**
Gets a string containing the window title.
-
+
@see SetTitle()
*/
- wxString GetTitle();
+ wxString GetTitle() const;
/**
Unique to the wxWinCE port. Responds to showing/hiding SIP (soft input panel)
/**
Iconizes or restores the window.
-
+
@param iconize
If @true, iconizes the window; if @false, shows and restores it.
-
+
@see IsIconized(), Maximize().
*/
void Iconize(bool iconize);
currently
working with it.
*/
- bool IsActive();
+ bool IsActive() const;
/**
Returns @true if this window is expected to be always maximized, either due
to platform policy
or due to local policy regarding particular class.
*/
- virtual bool IsAlwaysMaximized();
+ virtual bool IsAlwaysMaximized() const;
/**
Returns @true if the window is in fullscreen mode.
-
+
@see ShowFullScreen()
*/
bool IsFullScreen();
/**
Returns @true if the window is iconized.
*/
- bool IsIconized();
+ bool IsIconized() const;
/**
Returns @true if the window is maximized.
*/
- bool IsMaximized();
+ bool IsMaximized() const;
/**
@b @c This method is specific to wxUniversal port
Returns @true if this window is using native decorations, @false if we draw
them ourselves.
-
+
@see UseNativeDecorations(),
UseNativeDecorationsByDefault()
*/
- bool IsUsingNativeDecorations();
+ bool IsUsingNativeDecorations() const;
/**
Maximizes or restores the window.
-
+
@param maximize
If @true, maximizes the window, otherwise it restores it.
-
+
@see Iconize()
*/
void Maximize(bool maximize);
/**
Changes the default item for the panel, usually @a win is a button.
-
+
@see GetDefaultItem()
*/
void SetDefaultItem(wxWindow win);
/**
Sets the icon for this window.
-
+
@param icon
The icon to associate with this window.
-
+
@remarks The window takes a 'copy' of icon, but since it uses reference
counting, the copy is very quick. It is safe to delete
icon after calling this function.
different icons for different situations (e.g. task switching bar, taskbar,
window title bar) instead of scaling, with possibly bad looking results, the
only icon set by SetIcon().
-
+
@param icons
The icons to associate with this window.
-
+
@see wxIconBundle.
*/
void SetIcons(const wxIconBundle& icons);
Sets action or menu activated by pressing left hardware button on the smart
phones.
Unavailable on full keyboard machines.
-
+
@param id
Identifier for this button.
@param label
Text to be displayed on the screen area dedicated to this hardware button.
@param subMenu
The menu to be opened after pressing this hardware button.
-
+
@see SetRightMenu().
*/
void SetLeftMenu(int id = wxID_ANY,
Sets action or menu activated by pressing right hardware button on the smart
phones.
Unavailable on full keyboard machines.
-
+
@param id
Identifier for this button.
@param label
Text to be displayed on the screen area dedicated to this hardware button.
@param subMenu
The menu to be opened after pressing this hardware button.
-
+
@see SetLeftMenu().
*/
void SetRightMenu(int id = wxID_ANY,
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 incW
Specifies the increment for sizing the width (GTK/Motif/Xt only).
@param incH
@param incSize
Increment size (only taken into account under X11-based
ports such as wxGTK/wxMotif/wxX11).
-
+
@remarks Notice that this function not only prevents the user from
resizing the window outside the given bounds but it
also prevents the program itself from doing it using
/**
Sets the window title.
-
+
@param title
The window title.
-
+
@see GetTitle()
*/
virtual void SetTitle(const wxString& title);
/**
If the platform supports it will set the window to be translucent
-
+
@param alpha
Determines how opaque or transparent the window will
be, if the platform supports the opreration. A value of 0 sets the
By default, the application stays alive as long as there are any open top level
windows.
*/
- virtual bool ShouldPreventAppExit();
+ virtual bool ShouldPreventAppExit() const;
/**
Depending on the value of @a show parameter the window is either shown full
This function has not been tested with MDI frames.
Note that showing a window full screen also actually
@ref wxWindow::show Show()s if it hadn't been shown yet.
-
+
@see IsFullScreen()
*/
bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL);
Use native or custom-drawn decorations for this window only. Notice that to
have any effect this method must be called before really creating the window,
i.e. two step creation must be used:
-
+
@see UseNativeDecorationsByDefault(),
IsUsingNativeDecorations()
*/
*/
void UseNativeDecorationsByDefault(bool native = true);
};
+
projects / wxWidgets.git / blobdiff