-Sets the orientation (PS\_PORTRAIT or PS\_LANDSCAPE). The default is PS\_PORTRAIT.
-
-\membersection{::wxSetPrinterPreviewCommand}
-
-\func{void}{wxSetPrinterPreviewCommand}{\param{const wxString\& }{command}}
-
-Sets the command used to view a PostScript file. The default depends on the platform.
-
-\membersection{::wxSetPrinterScaling}
-
-\func{void}{wxSetPrinterScaling}{\param{float }{x}, \param{float }{y}}
-
-Sets the scaling factor for PostScript output. The default is 1.0, 1.0.
-
-\membersection{::wxSetPrinterTranslation}
-
-\func{void}{wxSetPrinterTranslation}{\param{float }{x}, \param{float }{y}}
-
-Sets the translation (from the top left corner) for PostScript output. The default is 0.0, 0.0.
-
-\section{Clipboard functions}\label{clipsboard}
-
-These clipboard functions are implemented for Windows only. The use of these functions
-is deprecated and the code is no longer maintained. Use the \helpref{wxClipboard}{wxclipboard}
-class instead.
-
-\wxheading{Include files}
-
-<wx/clipbrd.h>
-
-\membersection{::wxClipboardOpen}
-
-\func{bool}{wxClipboardOpen}{\void}
-
-Returns TRUE if this application has already opened the clipboard.
-
-\membersection{::wxCloseClipboard}
-
-\func{bool}{wxCloseClipboard}{\void}
-
-Closes the clipboard to allow other applications to use it.
-
-\membersection{::wxEmptyClipboard}
-
-\func{bool}{wxEmptyClipboard}{\void}
-
-Empties the clipboard.
-
-\membersection{::wxEnumClipboardFormats}
-
-\func{int}{wxEnumClipboardFormats}{\param{int}{dataFormat}}
-
-Enumerates the formats found in a list of available formats that belong
-to the clipboard. Each call to this function specifies a known
-available format; the function returns the format that appears next in
-the list.
-
-{\it dataFormat} specifies a known format. If this parameter is zero,
-the function returns the first format in the list.
-
-The return value specifies the next known clipboard data format if the
-function is successful. It is zero if the {\it dataFormat} parameter specifies
-the last format in the list of available formats, or if the clipboard
-is not open.
-
-Before it enumerates the formats function, an application must open the clipboard by using the
-wxOpenClipboard function.
-
-\membersection{::wxGetClipboardData}
-
-\func{wxObject *}{wxGetClipboardData}{\param{int}{dataFormat}}
-
-Gets data from the clipboard.
-
-{\it dataFormat} may be one of:
-
-\begin{itemize}\itemsep=0pt
-\item wxCF\_TEXT or wxCF\_OEMTEXT: returns a pointer to new memory containing a null-terminated text string.
-\item wxCF\_BITMAP: returns a new wxBitmap.
-\end{itemize}
-
-The clipboard must have previously been opened for this call to succeed.
-
-\membersection{::wxGetClipboardFormatName}
-
-\func{bool}{wxGetClipboardFormatName}{\param{int}{dataFormat}, \param{const wxString\& }{formatName}, \param{int}{maxCount}}
-
-Gets the name of a registered clipboard format, and puts it into the buffer {\it formatName} which is of maximum
-length {\it maxCount}. {\it dataFormat} must not specify a predefined clipboard format.
-
-\membersection{::wxIsClipboardFormatAvailable}
-
-\func{bool}{wxIsClipboardFormatAvailable}{\param{int}{dataFormat}}
-
-Returns TRUE if the given data format is available on the clipboard.
-
-\membersection{::wxOpenClipboard}
-
-\func{bool}{wxOpenClipboard}{\void}
-
-Opens the clipboard for passing data to it or getting data from it.
-
-\membersection{::wxRegisterClipboardFormat}
-
-\func{int}{wxRegisterClipboardFormat}{\param{const wxString\& }{formatName}}
-
-Registers the clipboard data format name and returns an identifier.
-
-\membersection{::wxSetClipboardData}
-
-\func{bool}{wxSetClipboardData}{\param{int}{dataFormat}, \param{wxObject *}{data}, \param{int}{width}, \param{int}{height}}
-
-Passes data to the clipboard.
-
-{\it dataFormat} may be one of:
-
-\begin{itemize}\itemsep=0pt
-\item wxCF\_TEXT or wxCF\_OEMTEXT: {\it data} is a null-terminated text string.
-\item wxCF\_BITMAP: {\it data} is a wxBitmap.
-\item wxCF\_DIB: {\it data} is a wxBitmap. The bitmap is converted to a DIB (device independent bitmap).
-\item wxCF\_METAFILE: {\it data} is a wxMetafile. {\it width} and {\it height} are used to give recommended dimensions.
-\end{itemize}
-
-The clipboard must have previously been opened for this call to succeed.
-
-\section{Miscellaneous functions}\label{miscellany}
-
-\membersection{::wxDROP\_ICON}\label{wxdropicon}
-
-\func{wxIconOrCursor}{wxDROP\_ICON}{\param{const char *}{name}}
-
-This macro creates either a cursor (MSW) or an icon (elsewhere) with the given
-name. Under MSW, the cursor is loaded from the resource file and the icon is
-loaded from XPM file under other platforms.
-
-This macro should be used with
-\helpref{wxDropSource constructor}{wxdropsourcewxdropsource}.
-
-\wxheading{Include files}
-
-<wx/dnd.h>
-
-\membersection{::wxNewId}
-
-\func{long}{wxNewId}{\void}
-
-Generates an integer identifier unique to this run of the program.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
-\membersection{::wxRegisterId}
-
-\func{void}{wxRegisterId}{\param{long}{ id}}
-
-Ensures that ids subsequently generated by {\bf NewId} do not clash with
-the given {\bf id}.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
-\membersection{::wxBeginBusyCursor}\label{wxbeginbusycursor}
-
-\func{void}{wxBeginBusyCursor}{\param{wxCursor *}{cursor = wxHOURGLASS\_CURSOR}}
-
-Changes the cursor to the given cursor for all windows in the application.
-Use \helpref{wxEndBusyCursor}{wxendbusycursor} to revert the cursor back
-to its previous state. These two calls can be nested, and a counter
-ensures that only the outer calls take effect.
-
-See also \helpref{wxIsBusy}{wxisbusy}, \helpref{wxBusyCursor}{wxbusycursor}.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
-\membersection{::wxBell}
-
-\func{void}{wxBell}{\void}
-
-Ring the system bell.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
-\membersection{::wxCreateDynamicObject}\label{wxcreatedynamicobject}
-
-\func{wxObject *}{wxCreateDynamicObject}{\param{const wxString\& }{className}}
-
-Creates and returns an object of the given class, if the class has been
-registered with the dynamic class system using DECLARE... and IMPLEMENT... macros.
-
-\membersection{::wxDDECleanUp}\label{wxddecleanup}
-
-\func{void}{wxDDECleanUp}{\void}
-
-Called when wxWindows exits, to clean up the DDE system. This no longer needs to be
-called by the application.
-
-See also \helpref{wxDDEInitialize}{wxddeinitialize}.
-
-\wxheading{Include files}
-
-<wx/dde.h>
-
-\membersection{::wxDDEInitialize}\label{wxddeinitialize}
-
-\func{void}{wxDDEInitialize}{\void}
-
-Initializes the DDE system. May be called multiple times without harm.
-
-This no longer needs to be called by the application: it will be called
-by wxWindows if necessary.
-
-See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
-\helpref{wxDDECleanUp}{wxddecleanup}.
-
-\wxheading{Include files}
-
-<wx/dde.h>
-
-\membersection{::wxDebugMsg}\label{wxdebugmsg}
-
-\func{void}{wxDebugMsg}{\param{const wxString\& }{fmt}, \param{...}{}}
-
-{\bf This function is deprecated, use \helpref{wxLogDebug}{wxlogdebug} instead!}
-
-Display a debugging message; under Windows, this will appear on the
-debugger command window, and under Unix, it will be written to standard
-error.
-
-The syntax is identical to {\bf printf}: pass a format string and a
-variable list of arguments.
-
-{\bf Tip:} under Windows, if your application crashes before the
-message appears in the debugging window, put a wxYield call after
-each wxDebugMsg call. wxDebugMsg seems to be broken under WIN32s
-(at least for Watcom C++): preformat your messages and use OutputDebugString
-instead.
-
-This function is now obsolete, replaced by \helpref{Log functions}{logfunctions}.
-
-\wxheading{Include files}
-
-<wx/utils.h>
-
-\membersection{::wxDisplaySize}
-
-\func{void}{wxDisplaySize}{\param{int *}{width}, \param{int *}{height}}
-
-Gets the physical size of the display in pixels.
-
-\wxheading{Include files}
-
-<wx/gdicmn.h>
-
-\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}
-
-<wx/utils.h>
-
-\membersection{::wxEntry}\label{wxentry}
-
-This initializes wxWindows in a platform-dependent way. Use this if you
-are not using the default wxWindows entry code (e.g. main or WinMain). For example,
-you can initialize wxWindows from an Microsoft Foundation Classes application using
-this function.
-
-\func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
- \param{const wxString\& }{commandLine}, \param{int}{ cmdShow}, \param{bool}{ enterLoop = TRUE}}
-
-wxWindows initialization under Windows (non-DLL). If {\it enterLoop} is FALSE, the
-function will return immediately after calling wxApp::OnInit. Otherwise, the wxWindows
-message loop will be entered.
-
-\func{void}{wxEntry}{\param{HANDLE}{ hInstance}, \param{HANDLE}{ hPrevInstance},
- \param{WORD}{ wDataSegment}, \param{WORD}{ wHeapSize}, \param{const wxString\& }{ commandLine}}
-
-wxWindows initialization under Windows (for applications constructed as a DLL).
-
-\func{int}{wxEntry}{\param{int}{ argc}, \param{const wxString\& *}{argv}}
-
-wxWindows initialization under Unix.
-
-\wxheading{Remarks}
-
-To clean up wxWindows, call wxApp::OnExit followed by the static function
-wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWindows:
-
-\begin{verbatim}
-int CTheApp::ExitInstance()
-{
- // OnExit isn't called by CleanUp so must be called explicitly.
- wxTheApp->OnExit();
- wxApp::CleanUp();
-
- return CWinApp::ExitInstance();
-}
-\end{verbatim}
-
-\wxheading{Include files}
-
-<wx/app.h>
-
-\membersection{::wxEndBusyCursor}\label{wxendbusycursor}
-
-\func{void}{wxEndBusyCursor}{\void}
-
-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}
-
-<wx/utils.h>
-
-\membersection{::wxError}\label{wxerror}
-
-\func{void}{wxError}{\param{const wxString\& }{msg}, \param{const wxString\& }{title = "wxWindows Internal Error"}}
-
-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}
-
-<wx/utils.h>
-
-\membersection{::wxExecute}\label{wxexecute}
-
-\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
-
-\func{long}{wxExecute}{\param{char **}{argv}, \param{bool }{sync = FALSE}, \param{wxProcess *}{callback = NULL}}
-
-\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}}
-
-\func{long}{wxExecute}{\param{const wxString\& }{command}, \param{wxArrayString\& }{output}, \param{wxArrayString\& }{errors}}
-
-Executes another program in Unix or Windows.
-
-The first form takes a command string, such as {\tt "emacs file.txt"}.
-
-The second form takes an array of values: a command, any number of
-arguments, terminated by NULL.
-
-The semantics of the third and fourth versions is different from the first two
-and is described in more details below.
-
-If {\it sync} is FALSE (the default), flow of control immediately returns.
-If TRUE, the current application waits until the other program has terminated.
-
-In the case of synchronous execution, the return value is the exit code of
-the process (which terminates by the moment the function returns) and will be
-$-1$ if the process couldn't be started and typically 0 if the process
-terminated successfully. Also, while waiting for the process to
-terminate, wxExecute will call \helpref{wxYield}{wxyield}. The caller
-should ensure that this can cause no recursion, in the simplest case by
-calling \helpref{wxEnableTopLevelWindows(FALSE)}{wxenabletoplevelwindows}.
-
-For asynchronous execution, however, the return value is the process id and
-zero value indicates that the command could not be executed. As an added
-complication, the return value of $-1$ in this case indicattes that we didn't
-launch a new process, but connected to the running one (this can only happen in
-case of using DDE under Windows for command execution). In particular, in this,
-and only this, case the calling code will not get the notification about
-process termination.
-
-If callback isn't NULL and if execution is asynchronous (note that callback
-parameter can not be non-NULL for synchronous execution),
-\helpref{wxProcess::OnTerminate}{wxprocessonterminate} will be called when
-the process finishes.
-
-Finally, you may use the third overloaded version of this function to execute
-a process (always synchronously) and capture its output in the array
-{\it output}. The fourth version adds the possibility to additionally capture
-the messages from standard error output in the {\it errors} array.
projects / wxWidgets.git / blobdiff