X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e8b04eb349f772582534d3e466983ada85f2460d..4d85bcd1f59a00ff4d626f0acc0b24474ec1aa09:/docs/latex/wx/function.tex diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex index e260c3d765..0bf399b079 100644 --- a/docs/latex/wx/function.tex +++ b/docs/latex/wx/function.tex @@ -1058,6 +1058,17 @@ Gets the physical size of the display in pixels. +\membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows} + +\func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}} + +This function enables or disables all top level windows. It is used by +\helpref{::wxSafeYield}{wxsafeyield}. + +\wxheading{Include files} + + + \membersection{::wxEntry}\label{wxentry} This initializes wxWindows in a platform-dependent way. Use this if you @@ -1101,26 +1112,26 @@ int CTheApp::ExitInstance() -\membersection{::wxError}\label{wxerror} +\membersection{::wxEndBusyCursor}\label{wxendbusycursor} -\func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}} +\func{void}{wxEndBusyCursor}{\void} -Displays {\it msg} and continues. This writes to standard error under -Unix, and pops up a message box under Windows. Used for internal -wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}. +Changes the cursor back to the original cursor, for all windows in the application. +Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}. + +See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}. \wxheading{Include files} -\membersection{::wxEndBusyCursor}\label{wxendbusycursor} - -\func{void}{wxEndBusyCursor}{\void} +\membersection{::wxError}\label{wxerror} -Changes the cursor back to the original cursor, for all windows in the application. -Use with \helpref{wxBeginBusyCursor}{wxbeginbusycursor}. +\func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}} -See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}. +Displays {\it msg} and continues. This writes to standard error under +Unix, and pops up a message box under Windows. Used for internal +wxWindows errors. See also \helpref{wxFatalError}{wxfatalerror}. \wxheading{Include files} @@ -1465,6 +1476,25 @@ Now obsolete: use \helpref{wxWindow::Close}{wxwindowclose} instead. +\membersection{::wxPostEvent}\label{wxpostevent} + +\func{void}{wxPostEvent}{\param{wxEvtHandler *}{dest}, \param{wxEvent\& }{event}} + +This function posts the event to the specified {\it dest} object. The +difference between sending an event and posting it is that in the first case +the event is processed before the function returns (in wxWindows, event sending +is done with \helpref{ProcessEvent}{wxevthandlerprocessevent} function), but in +the second, the function returns immediately and the event will be processed +sometime later - usually during the next even loop iteration. + +Note that a copy of the {\it event} is made by the function, so the original +copy can be deleted as soon as function returns. This function can also be used +to send events between different threads safely. + +\wxheading{Include files} + + + \membersection{::wxSafeYield}\label{wxsafeyield} \func{bool}{wxSafeYield}{\param{wxWindow*}{ win = NULL}} @@ -1480,18 +1510,6 @@ Returns the result of the call to \helpref{::wxYield}{wxyield}. -\membersection{::wxEnableTopLevelWindows}\label{wxenabletoplevelwindows} - -\func{void}{wxEnableTopLevelWindow}{\param{bool}{ enable = TRUE}} - -This function enables or disables all top level windows. It is used by -\helpref{::wxSafeYield}{wxsafeyield}. - -\wxheading{Include files} - - - - \membersection{::wxSetDisplayName}\label{wxsetdisplayname} \func{void}{wxSetDisplayName}{\param{const wxString\& }{displayName}} @@ -1667,7 +1685,7 @@ function. \wxheading{Include files} - + or \section{Macros}\label{macros} @@ -1929,7 +1947,7 @@ base classes. -\membersection{wxBITMAP}\label{wxbitmap} +\membersection{wxBITMAP}\label{wxbitmapmacro} \func{}{wxBITMAP}{bitmapName} @@ -1939,8 +1957,8 @@ avoid using {\tt #ifdef}s when creating bitmaps. \wxheading{See also} -\helpref{Bitmaps and icons overview}{wxbitmapoverview}, -\helpref{wxICON}{wxicon} +\helpref{Bitmaps and icons overview}{wxbitmapoverview}, +\helpref{wxICON}{wxiconmacro} \wxheading{Include files} @@ -1993,7 +2011,7 @@ Example: \helpref{RTTI overview}{runtimeclassoverview} -\membersection{wxICON}\label{wxicon} +\membersection{wxICON}\label{wxiconmacro} \func{}{wxICON}{iconName} @@ -2003,8 +2021,8 @@ avoid using {\tt #ifdef}s when creating icons. \wxheading{See also} -\helpref{Bitmaps and icons overview}{wxbitmapoverview}, -\helpref{wxBITMAP}{wxbitmap} +\helpref{Bitmaps and icons overview}{wxbitmapoverview}, +\helpref{wxBITMAP}{wxbitmapmacro} \wxheading{Include files}