From 2f3ebe4c1ace83fb2d8a54616bc2e3b8442e7e00 Mon Sep 17 00:00:00 2001 From: Julian Smart Date: Tue, 10 Oct 2000 10:50:27 +0000 Subject: [PATCH] Added wxGenericDirCtrl documentation git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@8508 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/category.tex | 1 + docs/latex/wx/classes.tex | 1 + docs/latex/wx/dirctrl.tex | 170 +++++++++++++++++++++++++++++++++++++ docs/latex/wx/wx.hpj | 2 +- 4 files changed, 173 insertions(+), 1 deletion(-) create mode 100644 docs/latex/wx/dirctrl.tex diff --git a/docs/latex/wx/category.tex b/docs/latex/wx/category.tex index 37611eab9d..ae3be1f878 100644 --- a/docs/latex/wx/category.tex +++ b/docs/latex/wx/category.tex @@ -84,6 +84,7 @@ that are not static can have \helpref{validators}{wxvalidator} associated with t \twocolitem{\helpref{wxChoice}{wxchoice}}{Choice control (a combobox without the editable area)} \twocolitem{\helpref{wxComboBox}{wxcombobox}}{A choice with an editable area} \twocolitem{\helpref{wxGauge}{wxgauge}}{A control to represent a varying quantity, such as time remaining} +\twocolitem{\helpref{wxGenericDirCtrl}{wxgenericdirctrl}}{A control for displaying a directory tree} \twocolitem{\helpref{wxStaticBox}{wxstaticbox}}{A static, or group box for visually grouping related controls} \twocolitem{\helpref{wxListBox}{wxlistbox}}{A list of strings for single or multiple selection} \twocolitem{\helpref{wxListCtrl}{wxlistctrl}}{A control for displaying lists of strings and/or icons, plus a multicolumn report view} diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex index 351e869f6f..021b419539 100644 --- a/docs/latex/wx/classes.tex +++ b/docs/latex/wx/classes.tex @@ -108,6 +108,7 @@ \input gauge.tex \input gdiobj.tex \input glcanvas.tex +\input dirctrl.tex \input valgen.tex \input grid.tex \input gridattr.tex diff --git a/docs/latex/wx/dirctrl.tex b/docs/latex/wx/dirctrl.tex new file mode 100644 index 0000000000..4563a56d19 --- /dev/null +++ b/docs/latex/wx/dirctrl.tex @@ -0,0 +1,170 @@ +\section{\class{wxGenericDirCtrl}}\label{wxgenericdirctrl} + +This control can be used to place a directory listing (with optional files) on an arbitrary window. + +The control contains a \helpref{wxTreeCtrl}{wxtreectrl} window representing the directory +hierarchy, and optionally, a \helpref{wxChoice}{wxchoice} window containing a list of filters. + +\wxheading{Derived from} + +\helpref{wxControl}{wxcontrol}\\ +\helpref{wxWindow}{wxwindow}\\ +\helpref{wxEvtHandler}{wxevthandler}\\ +\helpref{wxObject}{wxobject} + +\wxheading{Include files} + + + +\wxheading{Window styles} + +\twocolwidtha{5cm} +\begin{twocollist} +\twocolitem{{\bf \indexit{wxDIRCTRL\_DIR\_ONLY}}}{Only show directories, and not files.} +\twocolitem{{\bf \indexit{wxDIRCTRL\_3D\_INTERNAL}}}{Use 3D borders for internal controls.} +\twocolitem{{\bf \indexit{wxDIRCTRL\_SELECT\_FIRST}}}{When setting the default path, select the first file in the directory.} +\twocolitem{{\bf \indexit{wxDIRCTRL\_SHOW\_FILTERS}}}{Show the drop-down filter list.} +\end{twocollist} + +See also \helpref{Generic window styles}{windowstyles}. + +\wxheading{Data structures} + +\latexignore{\rtfignore{\wxheading{Members}}} + +\membersection{wxGenericDirCtrl::wxGenericDirCtrl}\label{wxgenericdirctrlwxgenericdirctrl} + +\func{}{wxGenericDirCtrl}{\void} + +Default constructor. + +\func{}{wxGenericDirCtrl}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id = -1}, + \param{const wxString\& }{dir = wxDirDialogDefaultFolderStr}, \param{const wxPoint\& }{pos = wxDefaultPosition}, + \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxDIRCTRL\_3D\_INTERNAL|wxSUNKEN\_BORDER}, + \param{const wxString\& }{filter = wxEmptyString}, + \param{int }{defaultFilter = 0}, + \param{const wxString\& }{name = wxTreeCtrlNameStr}} + +Main constructor. + +\wxheading{Parameters} + +\docparam{parent}{Parent window.} + +\docparam{id}{Window identifier.} + +\docparam{dir}{Initial folder.} + +\docparam{pos}{Position.} + +\docparam{size}{Size.} + +\docparam{style}{Window style. Please see \helpref{wxgenericdirctrl}{wxgenericdirctrl} for a list of possible styles.} + +\docparam{filter}{A filter string, using the same syntax as that for \helpref{wxFileDialog}{wxfiledialog}. This may be empty if filters +are not being used. + +Example: ``All files (*.*)|*.*|JPEG files (*.jpg)|*.jpg"} + +\docparam{defaultFilter}{The zero-indexed default filter setting.} + +\docparam{name}{The window name.} + +\membersection{wxGenericDirCtrl::\destruct{wxGenericDirCtrl}}\label{wxgenericdirctrldtor} + +\func{}{\destruct{wxGenericDirCtrl}}{\void} + +Destructor. + +\membersection{wxGenericDirCtrl::Create}\label{wxgenericdirctrlcreate} + +\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id = -1}, \param{const wxString\& }{dir = wxDirDialogDefaultFolderStr}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxDIRCTRL\_3D\_INTERNAL|wxSUNKEN\_BORDER}, \param{const wxString\& }{filter = wxEmptyString}, \param{int }{defaultFilter = 0}, \param{const wxString\& }{name = wxTreeCtrlNameStr}} + +Create function for two-step construction. See \helpref{wxGenericDirCtrl::wxGenericDirCtrl}{wxgenericdirctrlwxgenericdirctrl} for details. + +\membersection{wxGenericDirCtrl::Init}\label{wxgenericdirctrlinit} + +\func{void}{Init}{\void} + +Initializes variables. + +\membersection{wxGenericDirCtrl::ExpandPath}\label{wxgenericdirctrlexpandpath} + +\func{bool}{ExpandPath}{\param{const wxString\& }{path}} + +Tries to expand as much of the given path as possible, so that the filename or directory is visible in the tree control. + +\membersection{wxGenericDirCtrl::GetDefaultPath}\label{wxgenericdirctrlgetdefaultpath} + +\constfunc{wxString}{GetDefaultPath}{\void} + +Gets the default path. + +\membersection{wxGenericDirCtrl::GetPath}\label{wxgenericdirctrlgetpath} + +\constfunc{wxString}{GetPath}{\void} + +Gets the currently-selected directory or filename. + +\membersection{wxGenericDirCtrl::GetFilePath}\label{wxgenericdirctrlgetfilepath} + +\constfunc{wxString}{GetFilePath}{\void} + +Gets selected filename path only (else empty string). + +This function doen't count a directory as a selection. + +\membersection{wxGenericDirCtrl::GetFilter}\label{wxgenericdirctrlgetfilter} + +\constfunc{wxString}{GetFilter}{\void} + +Returns the filter string. + +\membersection{wxGenericDirCtrl::GetFilterIndex}\label{wxgenericdirctrlgetfilterindex} + +\constfunc{int}{GetFilterIndex}{\void} + +Returns the current filter index (zero-based). + +\membersection{wxGenericDirCtrl::GetFilterListCtrl}\label{wxgenericdirctrlgetfilterlistctrl} + +\constfunc{wxDirFilterListCtrl*}{GetFilterListCtrl}{\void} + +Returns a pointer to the filter list control (if present). + +\membersection{wxGenericDirCtrl::GetRootId}\label{wxgenericdirctrlgetrootid} + +\func{wxTreeItemId}{GetRootId}{\void} + +Returns the root id for the tree control. + +\membersection{wxGenericDirCtrl::GetTreeCtrl}\label{wxgenericdirctrlgettreectrl} + +\constfunc{wxTreeCtrl*}{GetTreeCtrl}{\void} + +Returns a pointer to the tree control. + +\membersection{wxGenericDirCtrl::SetDefaultPath}\label{wxgenericdirctrlsetdefaultpath} + +\func{void}{SetDefaultPath}{\param{const wxString\& }{path}} + +Sets the default path. + +\membersection{wxGenericDirCtrl::SetFilter}\label{wxgenericdirctrlsetfilter} + +\func{void}{SetFilter}{\param{const wxString\& }{filter}} + +Sets the filter string. + +\membersection{wxGenericDirCtrl::SetFilterIndex}\label{wxgenericdirctrlsetfilterindex} + +\func{void}{SetFilterIndex}{\param{int }{n}} + +Sets the current filter index (zero-based). + +\membersection{wxGenericDirCtrl::SetPath}\label{wxgenericdirctrlsetpath} + +\func{void}{SetPath}{\param{const wxString\& }{path}} + +Sets the current path. + diff --git a/docs/latex/wx/wx.hpj b/docs/latex/wx/wx.hpj index 61fbe30de4..7d53311fdd 100644 --- a/docs/latex/wx/wx.hpj +++ b/docs/latex/wx/wx.hpj @@ -1,5 +1,5 @@ [OPTIONS] -BMROOT=d:\wx2dev\wxWind~1\docs/latex/wx ; Assume that bitmaps are where the source is +BMROOT=. ; Assume that bitmaps are where the source is TITLE=wxWindows Manual CONTENTS=Contents COMPRESS=HIGH -- 2.45.2