]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/document.tex
More const bool (sigh)
[wxWidgets.git] / docs / latex / wx / document.tex
index 413dc2e7e551f0abcfd94571edd0c0b7a4451b19..a6dc7c39e6fba9fbd7993492c5090e266b811ced 100644 (file)
@@ -153,16 +153,13 @@ in many cases a document will only have a single view.
 
 See also: \helpref{GetViews}{wxdocumentgetviews}
 
-\membersection{wxDocument::GetPrintableName}\label{wxdocumentgetprintablename}
+\membersection{wxDocument::GetUserReadableName}\label{wxdocumentgetuserreadablentablename}
 
-\constfunc{virtual void}{GetPrintableName}{\param{wxString\& }{name}}
+\constfunc{virtual wxString}{GetUserReadableName}{\void}
 
-Copies a suitable document name into the supplied {\it name} buffer. The default
-function uses the title, or if there is no title, uses the filename; or if no
-filename, the string {\bf unnamed}. 
-
-\perlnote{In wxPerl this function must return the modified name rather
-than just modifying the argument.}
+Return the document name suitable to be shown to the user. The default
+implementation uses the document title, if any, of the name part of the
+document filename if it was set or, otherwise, the string {\bf unnamed}.
 
 \membersection{wxDocument::GetTitle}\label{wxdocumentgettitle}