X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9eace708fce7d0897616b4d2a93d517e41c3cf6e..11ef729d54ee338a1d569b5a238c2feb84d488ff:/docs/latex/wx/tlw.tex diff --git a/docs/latex/wx/tlw.tex b/docs/latex/wx/tlw.tex index 17404418fe..812eebd334 100644 --- a/docs/latex/wx/tlw.tex +++ b/docs/latex/wx/tlw.tex @@ -6,7 +6,7 @@ %% 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} @@ -67,6 +67,14 @@ Gets a string containing the window title. See \helpref{wxTopLevelWindow::SetTitle}{wxtoplevelwindowsettitle}. +\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} \func{void}{Iconize}{\param{bool}{ iconize}} @@ -140,8 +148,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} @@ -181,6 +189,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}}