initial commit
[rofl0r-KOL.git] / main_topendirdialog.htm
blobecbe40ae064333902b1726b877b48ee84d6811a2
1 <html>
2 <head>
3 <title>KOL Help: TOpenDirDialog object (main frame)</title>
4 <base target="_top">
5 </head>
7 <body bgcolor="#FFFFEF" text="#000000" link="#008080" vlink="#008000" alink="#808000">
8 <p><font face="Courier" color="#800080"><b>TOpenDirDialog( unit <a href=kol_pas.htm>KOL.pas</a> )
9 <font face="Wingdings">ï</font> <a href=tobj.htm>TObj</a>
10 <font face="Wingdings">ï</font> <a href=_tobj.htm>_TObj</a>
11 </b></font></p>
12 <p><b>
13 TOpenDirDialog = object( <a href=tobj.htm target="_top">TObj</a> )
14 </b></p>
15 Dialog for open directories, uses SHBrowseForFolder.
16 <h3 align="center"><font color="#FF8080">TOpenDirDialog properties</font></h3>
17 <a name="title"></a>
18 <p>
19 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>Title</b></font>: <b>String</b>;</font>
20 <br>
21 Title for a dialog.
22 </p>
23 <a name="options"></a>
24 <p>
25 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>Options</b></font>: <a href=kol_pas.htm#topendiroptions target="_top">TOpenDirOptions</a>;</font>
26 <br>
27 Option flags.
28 </p>
29 <a name="path"></a>
30 <p>
31 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>Path</b></font>: <b>String</b>;</font>
32 &nbsp;&nbsp;&nbsp;<font face="Webdings" size=7>&#209;</font>&nbsp;&nbsp;&nbsp;
33 <br>
34 Resulting (selected by user) path.
35 </p>
36 <a name="initialpath"></a>
37 <p>
38 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>InitialPath</b></font>: <b>String</b>;</font>
39 <br>
40 Set this property to a path of directory to be selected initially
41 in a dialog.
42 </p>
43 <a name="centeronscreen"></a>
44 <p>
45 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>CenterOnScreen</b></font>: <b>Boolean</b>;</font>
46 <br>
47 Set it to True to center dialog on screen.
48 </p>
49 <a name="wndowner"></a>
50 <p>
51 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>WndOwner</b></font>: HWnd;</font>
52 <br>
53 Owner window. If you want to provide your dialog visible over stay-on-top
54 form, fire it as a child of the form, assigning the handle of form window
55 to this property first.
56 </p>
57 <h4 align="center"><font color="black">Properties, inherited from <a href="tobj.htm" target="_top">TObj</a></font></h4>
58 <h3 align="center"><font color="#FF8080">TOpenDirDialog methods</font></h3>
59 <a name="destroy"></a>
60 <p>
61 <font face="Courier" color="#800080"><b>destructor</b> <font color="#808000"><b>Destroy</b></font>; <b>virtual</b>;</font>
62 <br>
63 destructor
64 </p>
65 <a name="execute"></a>
66 <p>
67 <font face="Courier" color="#800080"><b>function</b> <font color="#808000"><b>Execute</b></font>: <b>Boolean</b>;</font>
68 <br>
69 Call it to select directory by user. Returns True, if operation was
70 not cancelled by user.
71 </p>
72 <h4 align="center"><font color="black">Methods, inherited from <a href="tobj.htm" target="_top">TObj</a></font></h4>
73 <h3 align="center"><font color="#FF8080">TOpenDirDialog events</font></h3>
74 <a name="onselchanged"></a>
75 <p>
76 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>OnSelChanged</b></font>: <a href=kol_pas.htm#tonodselchange target="_top">TOnODSelChange</a>;</font>
77 <br>
78 This event is called every time, when user selects another directory.
79 It is possible to eneble/disable OK button in dialog and/or change
80 dialog status text in responce to event.
81 </p>
82 <h4 align="center"><font color="black">Events, inherited from <a href="tobj.htm" target="_top">TObj</a></font></h4>
83 <h3 align="center"><font color="#FF8080">TOpenDirDialog fields</font></h3>
84 <h4 align="center"><font color="black">Fields, inherited from <a href="tobj.htm" target="_top">TObj</a></font></h4>
85 <hr>
86 <p align="center">[&nbsp;<a href=index.htm>Index</a>&nbsp;]</p>
87 <p align="center"><font face="Comic Sans MS"><small>This help is generated 22-Sep-2005 by KOL Help generator, (C) 2000-2001 by Vladimir Kladov<br>Modified (C) 2003 by Alexander Bartov</small></font></p>
88 </body>
89 </html>