Added periods

[wxWidgets.git] / docs / latex / wx / dirctrl.tex

diff --git a/docs/latex/wx/dirctrl.tex b/docs/latex/wx/dirctrl.tex
index 42d6726c836ba2936d4fdae25cbe8ebf028513b4..190a63cdde722d7776463c440d3d33f6e8726ac9 100644 (file)
--- a/docs/latex/wx/dirctrl.tex
+++ b/docs/latex/wx/dirctrl.tex
@@ -18,13 +18,12 @@ hierarchy, and optionally, a \helpref{wxChoice}{wxchoice} window containing a li
 
 \wxheading{Window styles}
 
 
 \wxheading{Window styles}
 

-\twocolwidtha{5cm}
+\twocolwidtha{7cm}

 \begin{twocollist}
 \twocolitem{\indexit{wxDIRCTRL\_DIR\_ONLY}}{Only show directories, and not files.}
 \twocolitem{\indexit{wxDIRCTRL\_3D\_INTERNAL}}{Use 3D borders for internal controls.}
 \twocolitem{\indexit{wxDIRCTRL\_SELECT\_FIRST}}{When setting the default path, select the first file in the directory.}
 \begin{twocollist}
 \twocolitem{\indexit{wxDIRCTRL\_DIR\_ONLY}}{Only show directories, and not files.}
 \twocolitem{\indexit{wxDIRCTRL\_3D\_INTERNAL}}{Use 3D borders for internal controls.}
 \twocolitem{\indexit{wxDIRCTRL\_SELECT\_FIRST}}{When setting the default path, select the first file in the directory.}

-\twocolitem{\indexit{wxDIRCTRL\_SHOW\_FILTERS}}{Show the drop-down filter list.}
-\twocolitem{\indexit{wxDIRCTRL\_EDITABLE}}{Allow the folder and file items to be editable.}
+\twocolitem{\indexit{wxDIRCTRL\_EDIT\_LABELS}}{Allow the folder and file labels to be editable.}

 \end{twocollist}
 
 See also \helpref{Generic window styles}{windowstyles}.
 \end{twocollist}
 
 See also \helpref{Generic window styles}{windowstyles}.


@@ -41,7 +40,7 @@ Default constructor.
 
 \func{}{wxGenericDirCtrl}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id = -1},
  \param{const wxString\& }{dir = wxDirDialogDefaultFolderStr}, \param{const wxPoint\& }{pos = wxDefaultPosition},
 
 \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 wxSize\& }{size = wxDefaultSize}, \param{long }{style = wxDIRCTRL\_3D\_INTERNAL|wxBORDER\_SUNKEN},

  \param{const wxString\& }{filter = wxEmptyString},
  \param{int }{defaultFilter = 0},
  \param{const wxString\& }{name = wxTreeCtrlNameStr}}
  \param{const wxString\& }{filter = wxEmptyString},
  \param{int }{defaultFilter = 0},
  \param{const wxString\& }{name = wxTreeCtrlNameStr}}


@@ -79,7 +78,7 @@ Destructor.
 
 \membersection{wxGenericDirCtrl::Create}\label{wxgenericdirctrlcreate}
 
 
 \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}}
+\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|wxBORDER\_SUNKEN}, \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.
 
 
 Create function for two-step construction. See \helpref{wxGenericDirCtrl::wxGenericDirCtrl}{wxgenericdirctrlwxgenericdirctrl} for details.
 


@@ -89,12 +88,24 @@ Create function for two-step construction. See \helpref{wxGenericDirCtrl::wxGene
 
 Initializes variables.
 
 
 Initializes variables.
 

+\membersection{wxGenericDirCtrl::CollapseTree}\label{wxgenericdirctrlcollapsetree}
+
+\func{void}{CollapseTree}{\void}
+
+Collapses the entire tree.
+

 \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::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::CollapsePath}\label{wxgenericdirctrlcollapsepath}
+
+\func{bool}{CollapsePath}{\param{const wxString\& }{path}}
+
+Collapse the given path.
+

 \membersection{wxGenericDirCtrl::GetDefaultPath}\label{wxgenericdirctrlgetdefaultpath}
 
 \constfunc{wxString}{GetDefaultPath}{\void}
 \membersection{wxGenericDirCtrl::GetDefaultPath}\label{wxgenericdirctrlgetdefaultpath}
 
 \constfunc{wxString}{GetDefaultPath}{\void}


@@ -113,7 +124,7 @@ Gets the currently-selected directory or filename.
 
 Gets selected filename path only (else empty string).
 
 
 Gets selected filename path only (else empty string).
 

-This function doen't count a directory as a selection.
+This function doesn't count a directory as a selection.

 
 \membersection{wxGenericDirCtrl::GetFilter}\label{wxgenericdirctrlgetfilter}
 
 
 \membersection{wxGenericDirCtrl::GetFilter}\label{wxgenericdirctrlgetfilter}
 


@@ -145,6 +156,13 @@ Returns the root id for the tree control.
 
 Returns a pointer to the tree control.
 
 
 Returns a pointer to the tree control.
 

+\membersection{wxGenericDirCtrl::ReCreateTree}\label{wxgenericdirctrlrecreatetree}
+
+\func{void}{ReCreateTree}{\void}
+
+Collapse and expand the tree, thus re-creating it from scratch.
+May be used to update the displayed directory content.
+

 \membersection{wxGenericDirCtrl::SetDefaultPath}\label{wxgenericdirctrlsetdefaultpath}
 
 \func{void}{SetDefaultPath}{\param{const wxString\& }{path}}
 \membersection{wxGenericDirCtrl::SetDefaultPath}\label{wxgenericdirctrlsetdefaultpath}
 
 \func{void}{SetDefaultPath}{\param{const wxString\& }{path}}


@@ -169,3 +187,12 @@ Sets the current filter index (zero-based).
 
 Sets the current path.
 
 
 Sets the current path.
 

+\membersection{wxGenericDirCtrl::ShowHidden}\label{wxgenericdirctrlShowHidden}
+
+\func{void}{ShowHidden}{\param{bool }{show}}
+
+\wxheading{Parameters}
+
+\docparam{show}{If true, hidden folders and files will be displayed by the
+control. If false, they will not be displayed.}
+