]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/document.tex
added ReadType convenience functions (patch 1764160)
[wxWidgets.git] / docs / latex / wx / document.tex
index 413dc2e7e551f0abcfd94571edd0c0b7a4451b19..7d019d8fb9caf4705a80c9999b35a65591d78a0a 100644 (file)
@@ -14,6 +14,10 @@ and \helpref{wxDocManager}{wxdocmanager} classes.
 
 <wx/docview.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{wxDocument overview}{wxdocumentoverview}, \helpref{wxView}{wxview},\rtfsp
@@ -153,16 +157,13 @@ in many cases a document will only have a single view.
 
 See also: \helpref{GetViews}{wxdocumentgetviews}
 
-\membersection{wxDocument::GetPrintableName}\label{wxdocumentgetprintablename}
-
-\constfunc{virtual void}{GetPrintableName}{\param{wxString\& }{name}}
+\membersection{wxDocument::GetUserReadableName}\label{wxdocumentgetuserreadablentablename}
 
-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}. 
+\constfunc{virtual wxString}{GetUserReadableName}{\void}
 
-\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}