allow customization of individual grid lines appearance (patch 1496015)

[wxWidgets.git] / docs / latex / wx / tlw.tex

diff --git a/docs/latex/wx/tlw.tex b/docs/latex/wx/tlw.tex
index e713dd2f3ec439da41f6017a496767634b08aec4..2b7d1f647bf7021fb77db7b0a5d12da06bf7d0a8 100644 (file)
--- a/docs/latex/wx/tlw.tex
+++ b/docs/latex/wx/tlw.tex
@@ -6,12 +6,12 @@
 %% Created:     2004-09-07 (partly extracted from frame.tex)
 %% RCS-ID:      $Id$
 %% Copyright:   (c) 2004 Vadim Zeitlin
 %% 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}
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxTopLevelWindow}}\label{wxtoplevelwindow}
 

-wxTopLevelWindow is a common base class for \helpref{wxDialog}{wxdialog} and 
+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.
 \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.


@@ -29,6 +29,16 @@ applicable for the two classes above.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

+\membersection{wxTopLevelWindow::CanSetTransparent}\label{wxtoplevelwindowcansettransparent}
+
+\func{virtual bool}{CanSetTransparent}{\void}
+
+Returns \true if the platform supports making the window translucent.
+
+\wxheading{See also}
+
+\helpref{wxTopLevelWindow::SetTransparent}{wxtoplevelwindowsettransparent}
+

 
 \membersection{wxTopLevelWindow::GetIcon}\label{wxtoplevelwindowgeticon}
 
 
 \membersection{wxTopLevelWindow::GetIcon}\label{wxtoplevelwindowgeticon}
 


@@ -47,7 +57,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
 \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
 \helpref{SetIcons}{wxtoplevelwindowseticons} had been called before.
 
 Use \helpref{GetIcon}{wxtoplevelwindowgeticon} to get the main icon of the


@@ -64,7 +74,18 @@ window.
 
 Gets a string containing the window title.
 
 
 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}
 
 
 \membersection{wxTopLevelWindow::IsActive}\label{wxtoplevelwindowisactive}


@@ -75,6 +96,14 @@ Returns \true if this window is currently active, i.e. if the user is currently
 working with it.
 
 
 working with it.
 
 

+\membersection{wxTopLevelWindow::IsAlwaysMaximized}\label{wxtoplevelwindowisalwaysmaximized}
+
+\constfunc{virtual bool}{IsAlwaysMaximized}{\void}
+
+Returns \true if this window is expected to be always maximized, either due to platform policy
+or due to local policy regarding particular class.
+
+

 \membersection{wxTopLevelWindow::Iconize}\label{wxtoplevelwindowiconize}
 
 \func{void}{Iconize}{\param{bool}{ iconize}}
 \membersection{wxTopLevelWindow::Iconize}\label{wxtoplevelwindowiconize}
 
 \func{void}{Iconize}{\param{bool}{ iconize}}


@@ -125,10 +154,6 @@ Maximizes or restores the window.
 
 \docparam{maximize}{If \true, maximizes the window, otherwise it restores it.}
 
 
 \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}
 \wxheading{See also}
 
 \helpref{wxTopLevelWindow::Iconize}{wxtoplevelwindowiconize}


@@ -148,8 +173,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.
 
 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}
 
 
 \membersection{wxTopLevelWindow::SetIcon}\label{wxtoplevelwindowseticon}


@@ -237,7 +262,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
 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.
 
 
 operation is successful.
 
 


@@ -256,6 +281,34 @@ Sets the window title.
 \helpref{wxTopLevelWindow::GetTitle}{wxtoplevelwindowgettitle}
 
 
 \helpref{wxTopLevelWindow::GetTitle}{wxtoplevelwindowgettitle}
 
 

+\membersection{wxTopLevelWindow::SetTransparent}\label{wxtoplevelwindowsettransparent}
+
+\func{virtual bool}{SetTransparent}{\param{int }{ alpha}}
+
+If the platform supports it will set the window to be translucent
+
+\wxheading{Parameters}
+
+\docparam{alpha}{Determines how opaque or transparent the window will
+  be, if the platform supports the opreration.  A value of 0 sets the
+  window to be fully transparent, and a value of 255 sets the window
+  to be fully opaque.}
+
+Returns \true if the transparency was successfully changed.
+
+
+
+\membersection{wxTopLevelWindow::ShouldPreventAppExit}\label{wxtoplevelwindowshouldpreventappexit}
+
+\constfunc{virtual bool}{ShouldPreventAppExit}{\void}
+
+This virtual function is not meant to be called directly but can be overridden
+to return \false (it returns \true by default) to allow the application to
+close even if this, presumably not very important, window is still opened.
+By default, the application stays alive as long as there are any open top level
+windows.
+
+

 \membersection{wxTopLevelWindow::ShowFullScreen}\label{wxtoplevelwindowshowfullscreen}
 
 \func{bool}{ShowFullScreen}{\param{bool}{ show}, \param{long}{ style = wxFULLSCREEN\_ALL}}
 \membersection{wxTopLevelWindow::ShowFullScreen}\label{wxtoplevelwindowshowfullscreen}
 
 \func{bool}{ShowFullScreen}{\param{bool}{ show}, \param{long}{ style = wxFULLSCREEN\_ALL}}


@@ -282,4 +335,3 @@ Note that showing a window full screen also actually
 \wxheading{See also}
 
 \helpref{wxTopLevelWindow::IsFullScreen}{wxtoplevelwindowisfullscreen}
 \wxheading{See also}
 
 \helpref{wxTopLevelWindow::IsFullScreen}{wxtoplevelwindowisfullscreen}

-