]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/app.tex
removed unneeded wxWeakRefDynamic::AssignCopy() (last part of patch 1870445)
[wxWidgets.git] / docs / latex / wx / app.tex
index 74bb4a42ae5fedd56271f313ec0083bb60910092..adefdadd83d865eb066364b4572ae4f9a711c34c 100644 (file)
@@ -64,7 +64,13 @@ Number of command line arguments (after environment-specific processing).
 \member{wxChar **}{argv}
 
 Command line arguments (after environment-specific processing).
+Under Windows and Linux/Unix, you should parse the command line
+arguments and check for files to be opened when starting your
+application. Under OS X, you need to override \helpref{MacOpenFile}{wxappmacopenfile}
+since command line arguments are used differently there.
 
+You may use the \helpref{wxCmdLineParser}{wxcmdlineparser} to
+parse command line arguments.
 
 \membersection{wxApp::CreateLogTarget}\label{wxappcreatelogtarget}
 
@@ -139,9 +145,9 @@ is meant to be shown to the user and so should be used for the window titles,
 page headers and so on while the other one should be only used internally, e.g.
 for the file names or configuration file keys.
 
-By default, returns the same string as \headers{GetAppName}{wxappgetappname}.
+By default, returns the same string as \helpref{GetAppName}{wxappgetappname}.
 
-\newsince{3.0}
+\newsince{2.9.0}
 
 
 \membersection{wxApp::GetAppName}\label{wxappgetappname}
@@ -236,6 +242,21 @@ different visuals, false otherwise.
 \helpref{SetUseBestVisual}{wxappsetusebestvisual}
 
 
+\membersection{wxApp::GetVendorDisplayName}\label{wxappgetvendordisplayname}
+
+\constfunc{wxString}{GetVendorDisplayName}{\void}
+
+Returns the user-readable vendor name. The difference between this string
+and the one returned by \helpref{GetVendorName}{wxappgetvendorname} is that this one
+is meant to be shown to the user and so should be used for the window titles,
+page headers and so on while the other one should be only used internally, e.g.
+for the file names or configuration file keys.
+
+By default, returns the same string as \helpref{GetVendorName}{wxappgetvendorname}.
+
+\newsince{2.9.0}
+
+
 \membersection{wxApp::GetVendorName}\label{wxappgetvendorname}
 
 \constfunc{wxString}{GetVendorName}{\void}
@@ -266,6 +287,42 @@ if this function returns \false, non-blocking sockets cannot be used because
 the events from them would never be processed.
 
 
+\membersection{wxApp::MacNewFile}\label{wxappmacnewfile}
+
+\func{void}{MacNewFile}{\void}
+
+Mac specific. Called in response of an "open-application" Apple event.
+Override this to create a new document in your app.
+
+\membersection{wxApp::MacOpenFile}\label{wxappmacopenfile}
+
+\func{void}{MacOpenFile}{\param{const wxString\& }{fileName}}
+
+Mac specific. Called in response of an "open-document" Apple event. You need to 
+override this method in order to open a document file after the
+user double clicked on it or if the document file was dropped
+on either the running application or the application icon in
+Finder.
+
+\membersection{wxApp::MacOpenURL}\label{wxappmacopenurl}
+
+\func{void}{MacOpenURL}{\param{const wxString\& }{url}}
+
+Mac specific. Called in response of a "get-url" Apple event.
+
+\membersection{wxApp::MacPrintFile}\label{wxappmacprintfile}
+
+\func{void}{MacPrintFile}{\param{const wxString\& }{fileName}}
+
+Mac specific. Called in response of a "print-document" Apple event.
+
+
+\membersection{wxApp::MacReopenApp}\label{wxappmacreopenapp}
+
+\func{void}{MacReopenApp}{\void}
+
+Mac specific. Called in response of a "reopen-application" Apple event.
+
 \membersection{wxApp::MainLoop}\label{wxappmainloop}
 
 \func{virtual int}{MainLoop}{\void}
@@ -697,6 +754,14 @@ needs to use the top window.
 \helpref{wxApp::GetTopWindow}{wxappgettopwindow}, \helpref{wxApp::OnInit}{wxapponinit}
 
 
+\membersection{wxApp::SetVendorDisplayName}\label{wxappsetvendordisplayname}
+
+\func{void}{SetVendorDisplayName}{\param{const wxString\& }{name}}
+
+Set the vendor name to be used in the user-visible places. See
+\helpref{GetVendorDisplayName}{wxappgetvendordisplayname} for more about
+the differences between the display name and name.
+
 
 \membersection{wxApp::SetVendorName}\label{wxappsetvendorname}