X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/dc92adaf0c8d1d8b71b4a4cabe6f42c3a17f62a1..f303d69f934a76c56e14713a0748fdd10635e462:/docs/latex/wx/tlw.tex

diff --git a/docs/latex/wx/tlw.tex b/docs/latex/wx/tlw.tex
index f2e2fa1c03..91e4a75f3a 100644
--- a/docs/latex/wx/tlw.tex
+++ b/docs/latex/wx/tlw.tex
@@ -6,16 +6,26 @@
 %% Created:     2004-09-07 (partly extracted from frame.tex)
 %% RCS-ID:      $Id$
 %% Copyright:   (c) 2004 Vadim Zeitlin
-%% License:     wxWidgets license
+%% License:     wxWindows license
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxTopLevelWindow}}\label{wxtoplevelwindow}
 
-wxTopLevelWindow is a common base class for \helpref{wxDialog}{wxdialog} and 
-\helpref{wxTopLevelWindow}{wxtoplevelwindow}. It is an abstract base class meaning that you never
+wxTopLevelWindow is a common base class for \helpref{wxDialog}{wxdialog} and
+\helpref{wxFrame}{wxframe}. It is an abstract base class meaning that you never
 work with objects of this class directly, but all of its methods are also
 applicable for the two classes above.
 
+\wxheading{Derived from}
+
+\helpref{wxWindow}{wxwindow}\\
+\helpref{wxEvtHandler}{wxevthandler}\\
+\helpref{wxObject}{wxobject}
+
+\wxheading{Include files}
+
+<wx/toplevel.h>
+
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
@@ -37,7 +47,7 @@ been previously set by \helpref{SetIcon}{wxtoplevelwindowseticon}.
 \constfunc{const wxIconBundle\&}{GetIcons}{\void}
 
 Returns all icons associated with the window, there will be none of them if
-neither \helpref{SetIcon}{wxtoplevelwindowseticon} nor 
+neither \helpref{SetIcon}{wxtoplevelwindowseticon} nor
 \helpref{SetIcons}{wxtoplevelwindowseticons} had been called before.
 
 Use \helpref{GetIcon}{wxtoplevelwindowgeticon} to get the main icon of the
@@ -54,7 +64,26 @@ window.
 
 Gets a string containing the window title.
 
-See \helpref{wxTopLevelWindow::SetTitle}{wxtoplevelwindowsettitle}.
+\wxheading{See also}
+
+\helpref{wxTopLevelWindow::SetTitle}{wxtoplevelwindowsettitle}
+
+
+\membersection{wxTopLevelWindow::HandleSettingChange}\label{wxtoplevelwindowhandlesettingchange}
+
+\func{virtual bool}{HandleSettingChange}{\param{WXWPARAM}{ wParam}, \param{WXLPARAM}{ lParam}}
+
+Unique to the wxWinCE port. Responds to showing/hiding SIP (soft input panel) area and resize
+window accordingly. Override this if you want to avoid resizing or do additional
+operations.
+
+
+\membersection{wxTopLevelWindow::IsActive}\label{wxtoplevelwindowisactive}
+
+\constfunc{bool}{IsActive}{\void}
+
+Returns \true if this window is currently active, i.e. if the user is currently
+working with it.
 
 
 \membersection{wxTopLevelWindow::Iconize}\label{wxtoplevelwindowiconize}
@@ -107,10 +136,6 @@ Maximizes or restores the window.
 
 \docparam{maximize}{If \true, maximizes the window, otherwise it restores it.}
 
-\wxheading{Remarks}
-
-This function only works under Windows.
-
 \wxheading{See also}
 
 \helpref{wxTopLevelWindow::Iconize}{wxtoplevelwindowiconize}
@@ -130,8 +155,8 @@ action. When in doubt, use the default value.
 Note that this function should normally be only used when the application is
 not already in foreground.
 
-This function is currently only implemented for Win32 where it flashes the
-window icon in the taskbar.
+This function is currently implemented for Win32 where it flashes the
+window icon in the taskbar, and for wxGTK with task bars supporting it.
 
 
 \membersection{wxTopLevelWindow::SetIcon}\label{wxtoplevelwindowseticon}
@@ -171,6 +196,46 @@ only icon set by \helpref{SetIcon}{wxtoplevelwindowseticon}.
 \helpref{wxIconBundle}{wxiconbundle}.
 
 
+\membersection{wxTopLevelWindow::SetLeftMenu}\label{wxtoplevelwindowsetleftmenu}
+
+\func{void}{SetLeftMenu}{\param{int}{ id = wxID\_ANY}, \param{const wxString\&}{ label = wxEmptyString}, \param{wxMenu *}{ subMenu = NULL}}
+
+Sets action or menu activated by pressing left hardware button on the smart phones.
+Unavailable on full keyboard machines.
+
+\wxheading{Parameters}
+
+\docparam{id}{Identifier for this button.}
+
+\docparam{label}{Text to be displayed on the screen area dedicated to this hardware button.}
+
+\docparam{subMenu}{The menu to be opened after pressing this hardware button.}
+
+\wxheading{See also}
+
+\helpref{wxTopLevelWindow::SetRightMenu}{wxtoplevelwindowsetrightmenu}.
+
+
+\membersection{wxTopLevelWindow::SetRightMenu}\label{wxtoplevelwindowsetrightmenu}
+
+\func{void}{SetRightMenu}{\param{int}{ id = wxID\_ANY}, \param{const wxString\&}{ label = wxEmptyString}, \param{wxMenu *}{ subMenu = NULL}}
+
+Sets action or menu activated by pressing right hardware button on the smart phones.
+Unavailable on full keyboard machines.
+
+\wxheading{Parameters}
+
+\docparam{id}{Identifier for this button.}
+
+\docparam{label}{Text to be displayed on the screen area dedicated to this hardware button.}
+
+\docparam{subMenu}{The menu to be opened after pressing this hardware button.}
+
+\wxheading{See also}
+
+\helpref{wxTopLevelWindow::SetLeftMenu}{wxtoplevelwindowsetleftmenu}.
+
+
 \membersection{wxTopLevelWindow::SetShape}\label{wxtoplevelwindowsetshape}
 
 \func{bool}{SetShape}{\param{const wxRegion\&}{ region}}
@@ -179,7 +244,7 @@ If the platform supports it, sets the shape of the window to that
 depicted by {\it region}.  The system will not display or
 respond to any mouse event for the pixels that lie outside of the
 region.  To reset the window to the normal rectangular shape simply
-call {\it SetShape} again with an empty region.  Returns TRUE if the
+call {\it SetShape} again with an empty region.  Returns true if the
 operation is successful.
 
 
@@ -224,4 +289,3 @@ Note that showing a window full screen also actually
 \wxheading{See also}
 
 \helpref{wxTopLevelWindow::IsFullScreen}{wxtoplevelwindowisfullscreen}
-
