X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7f555861b7e50f335c7b929bb76be38e9ebd69c5..fa10c70ceb3a08a11302c00c9f0e29941174a21b:/docs/latex/wx/filehist.tex diff --git a/docs/latex/wx/filehist.tex b/docs/latex/wx/filehist.tex index 1d9001be31..9d47c7c36b 100644 --- a/docs/latex/wx/filehist.tex +++ b/docs/latex/wx/filehist.tex @@ -11,6 +11,10 @@ as well as the MDI parent frame. \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \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.