]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/filehist.tex
documented that wxHSCROLL disables wrapping; added comment to the source
[wxWidgets.git] / docs / latex / wx / filehist.tex
index 1d9001be31ca0e7c410e778710987c6b0860bfe1..9d47c7c36bc2e4edd92c5324ac06f603725e286f 100644 (file)
@@ -11,6 +11,10 @@ as well as the MDI parent frame.
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/docview.h>
+
 \wxheading{See also}
 
 \helpref{wxFileHistory overview}{wxfilehistoryoverview}, \helpref{wxDocManager}{wxdocmanager}
@@ -26,13 +30,13 @@ files.
 
 \membersection{wxFileHistory::m\_fileHistoryN}
 
-\member{int}{m\_fileHistoryN}
+\member{size\_t}{m\_fileHistoryN}
 
 The number of files stored in the history array.
 
 \membersection{wxFileHistory::m\_fileMaxFiles}
 
-\member{int}{m\_fileMaxFiles}
+\member{size\_t}{m\_fileMaxFiles}
 
 The maximum number of files to be stored and displayed on the menu.
 
@@ -44,9 +48,15 @@ The file menu used to display the file history list (if enabled).
 
 \membersection{wxFileHistory::wxFileHistory}
 
-\func{}{wxFileHistory}{\param{int}{ maxFiles = 9}}
+\func{}{wxFileHistory}{\param{size\_t}{ maxFiles = 9}, \param{wxWindowID}{ idBase = wxID\_FILE1}}
+
+Constructor. Pass the maximum number of files that should be stored and
+displayed.
 
-Constructor. Pass the maximum number of files that should be stored and displayed.
+{\it idBase} defaults to wxID\_FILE1 and represents the id given to the first
+history menu item.  Since menu items can't share the same ID you should change
+idBase (To one of your own defined IDs) when using more than one wxFileHistory
+in your application.
 
 \membersection{wxFileHistory::\destruct{wxFileHistory}}
 
@@ -72,19 +82,19 @@ Appends the files in the history list, to the given menu only.
 
 \membersection{wxFileHistory::GetHistoryFile}\label{wxfilehistorygethistoryfile}
 
-\constfunc{wxString}{GetHistoryFile}{\param{int}{ index}}
+\constfunc{wxString}{GetHistoryFile}{\param{size\_t}{ index}}
 
 Returns the file at this index (zero-based).
 
 \membersection{wxFileHistory::GetMaxFiles}
 
-\constfunc{int}{GetMaxFiles}{\void}
+\constfunc{size\_t}{GetMaxFiles}{\void}
 
 Returns the maximum number of files that can be stored.
 
 \membersection{wxFileHistory::GetNoHistoryFiles}
 
-\constfunc{int}{GetNoHistoryFiles}{\void}
+\constfunc{size\_t}{GetNoHistoryFiles}{\void}
 
 Returns the number of files currently stored in the file history.