X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a7af285d1ab87e908454bfabbbe063ab1756912b..380740af5dd112601916704a6d78d1112ebb31b5:/docs/latex/wx/app.tex diff --git a/docs/latex/wx/app.tex b/docs/latex/wx/app.tex index b9ac70ab28..ab2a324b64 100644 --- a/docs/latex/wx/app.tex +++ b/docs/latex/wx/app.tex @@ -129,6 +129,21 @@ had been already processed (for the former return value) or that it is not going to be processed at all (for the latter one). +\membersection{wxApp::GetAppDisplayName}\label{wxappgetappdisplayname} + +\constfunc{wxString}{GetAppDisplayName}{\void} + +Returns the user-readable application name. The difference between this string +and the one returned by \helpref{GetAppName}{wxappgetappname} 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{GetAppName}{wxappgetappname}. + +\newsince{2.9.0} + + \membersection{wxApp::GetAppName}\label{wxappgetappname} \constfunc{wxString}{GetAppName}{\void} @@ -140,6 +155,10 @@ Returns the application name. wxWidgets sets this to a reasonable default before calling \helpref{wxApp::OnInit}{wxapponinit}, but the application can reset it at will. +\wxheading{See also} + +\helpref{GetAppDisplayName}{wxappgetappdisplayname} + \membersection{wxApp::GetClassName}\label{wxappgetclassname} @@ -217,6 +236,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} @@ -587,13 +621,25 @@ If true is returned, more OnIdle processing is requested by one or more window. \helpref{wxIdleEvent}{wxidleevent} +\membersection{wxApp::SetAppDisplayName}\label{wxappsetappdisplayname} + +\func{void}{SetAppDisplayName}{\param{const wxString\& }{name}} + +Set the application name to be used in the user-visible places such as window +titles. See \helpref{GetAppDisplayName}{wxappgetappdisplayname} for more about +the differences between the display name and name. + + \membersection{wxApp::SetAppName}\label{wxappsetappname} \func{void}{SetAppName}{\param{const wxString\& }{name}} -Sets the name of the application. The name may be used in dialogs -(for example by the document/view framework). A default name is set by -wxWidgets. +Sets the name of the application. This name should be used for file names, +configuration file entries and other internal strings. For the user-visible +strings, such as the window titles, the application display name set by +\helpref{SetAppDisplayName}{wxappsetappdisplayname} is used instead. + +By default the application name is set to the name of its executable file. \wxheading{See also} @@ -666,6 +712,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}