Added deprecated property classes for future reference (maybe separate manual)

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

diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex
index 0ac86c78f7041560ccbd9ff487c76ece81015d8a..41cd0d5c3536818f5f21120beff939a50c7976e8 100644 (file)
--- a/docs/latex/wx/function.tex
+++ b/docs/latex/wx/function.tex
@@ -120,6 +120,7 @@ the corresponding topic.
 \helpref{wxGetSingleChoice}{wxgetsinglechoice}\\
 \helpref{wxGetTempFileName}{wxgettempfilename}\\
 \helpref{wxGetTextFromUser}{wxgettextfromuser}\\
+\helpref{wxGetTopLevelParent}{wxgettoplevelparent}\\
 \helpref{wxGetTranslation}{wxgettranslation}\\
 \helpref{wxGetUTCTime}{wxgetutctime}\\
 \helpref{wxGetUserHome}{wxgetuserhome}\\
@@ -179,6 +180,7 @@ the corresponding topic.
 \helpref{wxResourceRegisterBitmapData}{registerbitmapdata}\\
 \helpref{wxResourceRegisterIconData}{wxresourceregistericondata}\\
 \helpref{wxRmdir}{wxrmdir}\\
+\helpref{wxSafeShowMessage}{wxsafeshowmessage}\\
 \helpref{wxSafeYield}{wxsafeyield}\\
 \helpref{wxSetClipboardData}{wxsetclipboarddata}\\
 \helpref{wxSetCursor}{wxsetcursor}\\
@@ -195,6 +197,7 @@ the corresponding topic.
 \helpref{wxSetWorkingDirectory}{wxsetworkingdirectory}\\
 \helpref{wxShell}{wxshell}\\
 \helpref{wxShowTip}{wxshowtip}\\
+\helpref{wxShutdown}{wxshutdown}\\
 \helpref{wxSleep}{wxsleep}\\
 \helpref{wxSnprintf}{wxsnprintf}\\
 \helpref{wxSplitPath}{wxsplitfunction}\\
@@ -594,6 +597,26 @@ See also \helpref{wxExecute}{wxexecute}, \helpref{Exec sample}{sampleexec}.
 
 <wx/utils.h>
 
+\membersection{::wxShutdown}\label{wxshutdown}
+
+\func{bool}{wxShutdown}{\param{wxShutdownFlags}{flags}}
+
+This function shuts down or reboots the computer depending on the value of the 
+{\it flags}. Please notice that doing this requires the corresponding access
+rights (superuser under Unix, {\tt SE\_SHUTDOWN} privelege under Windows NT)
+and that this function is only implemented under Unix and Win32.
+
+\wxheading{Parameters}
+
+\docparam{flags}{Either {\tt wxSHUTDOWN\_POWEROFF} or {\tt wxSHUTDOWN\_REBOOT}}
+
+\wxheading{Returns}
+
+{\tt TRUE} on success, {\tt FALSE} if an error occured.
+
+\wxheading{Include files}
+
+<wx/utils.h>
 
 \section{Thread functions}\label{threadfunctions}
 
@@ -2233,6 +2256,17 @@ See also \helpref{wxWriteResource}{wxwriteresource}, \helpref{wxConfigBase}{wxco
 
 <wx/utils.h>
 
+\membersection{::wxGetTopLevelParent}\label{wxgettoplevelparent}
+
+\func{wxWindow *}{wxGetTopLevelParent}{\param{wxWindow }{*win}}
+
+Returns the first top level parent of the given window, or in other words, the
+frame or dialog containing it, or {\tt NULL}.
+
+\wxheading{Include files}
+
+<wx/window.h>
+
 \membersection{::wxLoadUserResource}\label{wxloaduserresource}
 
 \func{wxString}{wxLoadUserResource}{\param{const wxString\& }{resourceName}, \param{const wxString\& }{resourceType=``TEXT"}}
@@ -2352,7 +2386,7 @@ See also \helpref{wxGetResource}{wxgetresource}, \helpref{wxConfigBase}{wxconfig
 
 <wx/utils.h>
 
-\section{Byte order macros}\label{byeordermacros}
+\section{Byte order macros}\label{byteordermacros}
 
 The endian-ness issues (that is the difference between big-endian and
 little-endian architectures) are important for the portable programs working
@@ -2748,7 +2782,7 @@ loading from resource data.
 \func{bool}{wxResourceAddIdentifier}{\param{const wxString\& }{name}, \param{int }{value}}
 
 Used for associating a name with an integer identifier (equivalent to dynamically\rtfsp
-\tt{#}defining a name to an integer). Unlikely to be used by an application except
+{\tt\#}defining a name to an integer). Unlikely to be used by an application except
 perhaps for implementing resource functionality for interpreted languages.
 
 \membersection{::wxResourceClear}\label{wxresourceclear}
@@ -2914,7 +2948,7 @@ load an entire {\tt .wxr file} into a string.
 
 \func{bool}{wxResourceRegisterBitmapData}{\param{const wxString\& }{name}, \param{char **}{xpm\_data}}
 
-Makes \tt{#}included XBM or XPM bitmap data known to the wxWindows resource system.
+Makes {\tt\#}included XBM or XPM bitmap data known to the wxWindows resource system.
 This is required if other resources will use the bitmap data, since otherwise there
 is no connection between names used in resources, and the global bitmap data.
 
@@ -3135,6 +3169,32 @@ trace masks.
 \item wxTraceOleCalls: trace OLE method calls (Win32 only)
 \end{itemize}
 
+\membersection{::wxSafeShowMessage}\label{wxsafeshowmessage}
+
+\func{void}{wxSafeShowMessage}{\param{const wxString\& }{title}, \param{const wxString\& }{text}}
+
+This function shows a message to the user in a safe way and should be safe to
+call even before the application has been initialized or if it is currently in
+some other strange state (for example, about to crash). Under Windows this
+function shows a message box using a native dialog instead of 
+\helpref{wxMessageBox}{wxmessagebox} (which might be unsafe to call), elsewhere
+it simply prints the message to the standard output using the title as prefix.
+
+\wxheading{Parameters}
+
+\docparam{title}{The title of the message box shown to the user or the prefix
+of the message string}
+
+\docparam{text}{The text to show to the user}
+
+\wxheading{See also}
+
+\helpref{wxLogFatalError}{wxlogfatalerror}
+
+\wxheading{Include files}
+
+<wx/log.h>
+
 \membersection{::wxSysErrorCode}\label{wxsyserrorcode}
 
 \func{unsigned long}{wxSysErrorCode}{\void}
@@ -3263,14 +3323,14 @@ Returns the number of seconds since local time 00:00:00 Jan 1st 1970.
 
 \membersection{::wxGetLocalTimeMillis}\label{wxgetlocaltimemillis}
 
-\func{wxLongLone}{wxGetLocalTimeMillis}{\void}
+\func{wxLongLong}{wxGetLocalTimeMillis}{\void}
 
 Returns the number of milliseconds since local time 00:00:00 Jan 1st 1970.
 
 \wxheading{See also}
 
 \helpref{wxDateTime::Now}{wxdatetimenow},\\
-\helpref{wxLongLone}{wxlonglong}
+\helpref{wxLongLong}{wxlonglong}
 
 \wxheading{Include files}
 
@@ -3416,7 +3476,7 @@ specified {\it condition} is false. The compiler error message should include
 the {\it msg} identifier - please note that it must be a valid C++ identifier
 and not a string unlike in the other cases.
 
-This macro is mostly useful for testing the expressions involing the 
+This macro is mostly useful for testing the expressions involving the 
 {\tt sizeof} operator as they can't be tested by the preprocessor but it is
 sometimes desirable to test them at the compile time.