1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
|
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lcl">
<!--
====================================================================
FileCtrl
====================================================================
-->
<module name="FileCtrl">
<short>Class definitions for a box with a list of files for selection</short>
<descr/>
<!-- enumeration type Visibility: default -->
<element name="TFileAttr">
<short>
<var>TFileAttr</var> - enumerated type listing file attributes for a file list box</short>
<descr/>
<seealso/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TFileAttr.ftReadOnly">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TFileAttr.ftHidden">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TFileAttr.ftSystem">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TFileAttr.ftVolumeID">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TFileAttr.ftDirectory">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TFileAttr.ftArchive">
<short/>
</element>
<!-- enumeration value Visibility: default -->
<element name="TFileAttr.ftNormal">
<short/>
</element>
<!-- set type Visibility: default -->
<element name="TFileType">
<short>
<var>TFileType</var> - set of file attributes</short>
<descr/>
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TCustomFileListBox">
<short>
<var>TCustomFileListBox</var> : base type for <var>TFileListBox</var> - a tool for listing files for selection</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TCustomFileListBox.MaskIsStored.Result">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomFileListBox.DoChangeFile">
<short>
<var>DoChangeFile</var> - method to change a file selection: calls the <var>OnChange</var> event handler</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomFileListBox.UpdateFileList">
<short>
<var>UpdateFileList</var> - brings the list of files up to date, taking into account any changes</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomFileListBox.Click" link="#LCL.Controls.TControl.Click">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomFileListBox.Loaded" link="#rtl.Classes.TComponent.Loaded">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function Visibility: protected -->
<element name="TCustomFileListBox.IndexOfFile">
<short>
<var>IndexOfFile</var> - number of the selected file in the list of files</short>
<descr/>
<errors/>
<seealso/>
</element>
<!-- function result Visibility: default -->
<element name="TCustomFileListBox.IndexOfFile.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomFileListBox.IndexOfFile.AFilename">
<short/>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomFileListBox.KeyUp" link="#LCL.Controls.TWinControl.KeyUp">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomFileListBox.KeyUp.Key">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomFileListBox.KeyUp.Shift">
<short/>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomFileListBox.Create" link="#rtl.Classes.TComponent.Create">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomFileListBox.Create.TheOwner">
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomFileListBox.Destroy" link="#rtl.Classes.TComponent.Destroy">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TCustomFileListBox.Drive">
<short>The <var>Drive</var> on which the file is located (applies to Windows systems)</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TCustomFileListBox.Directory">
<short>The <var>Directory</var> or Folder in which the file is located</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TCustomFileListBox.FileName">
<short>
<var>FileName</var> - the name of the selected file</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TCustomFileListBox.FileType">
<short>
<var>FileType</var> - the type or attributes of the selected file</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TCustomFileListBox.Mask">
<short>Specifies which files will be shown</short>
<descr>
<p>This property should be filled with a list of masks separated by semi-colons. For example: "*.pdf;*.svg" will show all files with the extensions pdf and svg. The default value for this property is "*" which for this control will be consider the generic mask meaning any file. Do not use the Windows specific mask "*.*" to attempt to show all files, which is the behavior from Delphi. In the LCL version of the control this will require the file name to have a point.</p>
<p>Allowed wildcarss are "*" which means zero or more characters and "?" which means exactly 1 character of any kind. Other characters represent themselves with one important detail: The file matching algorithm is case insensitive. So if you set "*.PDF" in the mask, then "PostScript.pdf" will also be shown, even in Linux in a case-sensitive file system.</p>
<p>This property has exactly the same rules and behavior as TFilterComboBox.Mask.</p>
</descr>
<seealso>
<link id="TCustomFilterComboBox.Mask"/>
</seealso>
</element>
<!-- property Visibility: public -->
<element name="TCustomFileListBox.OnChange">
<short>
<var>OnChange</var> - event handler for a change in the file list or the selection</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: public -->
<element name="TCustomFileListBox.Sorted" link="#LCL.StdCtrls.TCustomListBox.Sorted"/>
<!-- object Visibility: default -->
<element name="TFileListBox">
<short>
<var>TFileListBox</var> - a tool for listing files for selection</short>
<descr/>
<errors/>
<seealso/>
</element>
<element name="TFileListBox.Align" link="#LCL.Controls.TControl.Align"/>
<element name="TFileListBox.Anchors" link="#LCL.Controls.TControl.Anchors"/>
<element name="TFileListBox.BorderStyle" link="#LCL.Controls.TWinControl.BorderStyle"/>
<element name="TFileListBox.Constraints" link="#LCL.Controls.TControl.Constraints"/>
<element name="TFileListBox.ExtendedSelect" link="#LCL.StdCtrls.TCustomListBox.ExtendedSelect"/>
<element name="TFileListBox.FileType" link="#LCL.FileCtrl.TCustomFileListBox.FileType"/>
<element name="TFileListBox.Font" link="#LCL.Controls.TControl.Font"/>
<element name="TFileListBox.IntegralHeight" link="#LCL.StdCtrls.TCustomListBox.IntegralHeight"/>
<element name="TFileListBox.ItemHeight" link="#LCL.StdCtrls.TCustomListBox.ItemHeight"/>
<!-- property Visibility: published -->
<element name="TFileListBox.Mask" link="#LCL.FileCtrl.TCustomFileListBox.Mask"/>
<element name="TFileListBox.MultiSelect" link="#LCL.StdCtrls.TCustomListBox.MultiSelect"/>
<element name="TFileListBox.OnChange" link="#LCL.FileCtrl.TCustomFileListBox.OnChange"/>
<element name="TFileListBox.OnChangeBounds" link="#LCL.Controls.TControl.OnChangeBounds"/>
<element name="TFileListBox.Directory" link="#LCL.FileCtrl.TCustomFileListBox.Directory"/>
<element name="TFileListBox.DragCursor" link="#LCL.Controls.TControl.DragCursor"/>
<element name="TFileListBox.DragMode" link="#LCL.Controls.TControl.DragMode"/>
<element name="TFileListBox.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop"/>
<element name="TFileListBox.OnDragOver" link="#LCL.Controls.TControl.OnDragOver"/>
<element name="TFileListBox.OnEndDrag" link="#LCL.Controls.TControl.OnEndDrag"/>
<element name="TFileListBox.OnStartDrag" link="#LCL.Controls.TControl.OnStartDrag"/>
<element name="TFileListBox.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
<element name="TFileListBox.OnClick" link="#LCL.Controls.TControl.OnClick"/>
<element name="TFileListBox.OnDblClick" link="#LCL.Controls.TControl.OnDblClick"/>
<element name="TFileListBox.OnEnter" link="#LCL.Controls.TWinControl.OnEnter"/>
<element name="TFileListBox.OnExit" link="#LCL.Controls.TWinControl.OnExit"/>
<element name="TFileListBox.OnKeyPress" link="#LCL.Controls.TWinControl.OnKeyPress"/>
<element name="TFileListBox.OnKeyDown" link="#LCL.Controls.TWinControl.OnKeyDown"/>
<element name="TFileListBox.OnKeyUp" link="#LCL.Controls.TWinControl.OnKeyUp"/>
<element name="TFileListBox.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove"/>
<element name="TFileListBox.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown"/>
<element name="TFileListBox.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp"/>
<element name="TFileListBox.OnMouseWheel" link="#LCL.Controls.TControl.OnMouseWheel"/>
<element name="TFileListBox.OnMouseWheelDown" link="#LCL.Controls.TControl.OnMouseWheelDown"/>
<element name="TFileListBox.OnMouseWheelUp" link="#LCL.Controls.TControl.OnMouseWheelUp"/>
<element name="TFileListBox.OnResize" link="#LCL.Controls.TControl.OnResize"/>
<element name="TFileListBox.ParentShowHint" link="#LCL.Controls.TControl.ParentShowHint"/>
<element name="TFileListBox.ParentFont" link="#LCL.Controls.TControl.ParentFont"/>
<element name="TFileListBox.PopupMenu" link="#LCL.Controls.TControl.PopupMenu"/>
<element name="TFileListBox.ShowHint" link="#LCL.Controls.TControl.ShowHint"/>
<element name="TFileListBox.OnMouseWheelUp" link="#LCL.Controls.TControl.OnMouseWheelUp"/>
<element name="TFileListBox.Sorted" link="#LCL.StdCtrls.TCustomListBox.Sorted"/>
<element name="TFileListBox.Style" link="#LCL.StdCtrls.TCustomListBox.Style"/>
<element name="TFileListBox.TabOrder" link="#LCL.Controls.TWinControl.TabOrder"/>
<element name="TFileListBox.TabStop" link="#LCL.Controls.TWinControl.TabStop"/>
<element name="TFileListBox.TopIndex" link="#LCL.StdCtrls.TCustomListBox.TopIndex"/>
<element name="TFileListBox.Visible" link="#LCL.Controls.TControl.Visible"/>
<element name="TFileListBox.BiDiMode" link="#LCL.Controls.TControl.BiDiMode"/>
<element name="TFileListBox.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing"/>
<element name="TFileListBox.OnSelectionChange" link="#LCL.StdCtrls.TCustomListBox.OnSelectionChange"/>
<element name="TFileListBox.ParentBiDiMode" link="#LCL.Controls.TControl.ParentBiDiMode"/>
<!-- class Visibility: default -->
<element name="TCustomFilterComboBox">
<short>A combobox to select filename filters</short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomFilterComboBox.Select">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomFilterComboBox.Create">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCustomFilterComboBox.Create.TheOwner">
<short/>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomFilterComboBox.Destroy">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- class procedure Visibility: default -->
<element name="TCustomFilterComboBox.ConvertFilterToStrings">
<short/>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCustomFilterComboBox.ConvertFilterToStrings.AFilter">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomFilterComboBox.ConvertFilterToStrings.AStrings">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomFilterComboBox.ConvertFilterToStrings.AClearStrings">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomFilterComboBox.ConvertFilterToStrings.AAddDescription">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="TCustomFilterComboBox.ConvertFilterToStrings.AAddFilter">
<short/>
</element>
<!-- property Visibility: public -->
<element name="TCustomFilterComboBox.Mask">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: public -->
<element name="TCustomFilterComboBox.ShellListView">
<short>Allows to concect this control to a TShellListView</short>
<descr>The files shown in the TShellListView will be filtered by the filter selected in this control
</descr>
<seealso>
</seealso>
</element>
<!-- class Visibility: default -->
<element name="TFilterComboBox">
<short>A combobox to select filename filters</short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<element name="TFilterComboBox.Align" link="#LCL.Controls.TControl.Align"/>
<element name="TFilterComboBox.Anchors" link="#LCL.Controls.TControl.Anchors"/>
<element name="TFilterComboBox.AutoComplete" link="#LCL.StdCtrls.TCustomComboBox.AutoComplete"/>
<element name="TFilterComboBox.AutoDropDown" link="#LCL.StdCtrls.TCustomComboBox.AutoDropDown"/>
<element name="TFilterComboBox.AutoSize" link="#LCL.Controls.TControl.AutoSize"/>
<element name="TFilterComboBox.BidiMode" link="#LCL.Controls.TControl.BidiMode"/>
<element name="TFilterComboBox.BorderSpacing" link="#LCL.Controls.TControl.BorderSpacing"/>
<element name="TFilterComboBox.Color" link="#LCL.Controls.TControl.Color"/>
<element name="TFilterComboBox.Constraints" link="#LCL.Controls.TControl.Constraints"/>
<element name="TFilterComboBox.DragCursor" link="#LCL.Controls.TControl.DragCursor"/>
<element name="TFilterComboBox.DragKind" link="#LCL.Controls.TControl.DragKind"/>
<element name="TFilterComboBox.DragMode" link="#LCL.Controls.TControl.DragMode"/>
<element name="TFilterComboBox.Enabled" link="#LCL.Controls.TControl.Enabled"/>
<element name="TFilterComboBox.Filter" link="#LCL.StdCtrls.TCustomComboBox.Filter"/>
<element name="TFilterComboBox.Font" link="#LCL.Controls.TControl.Font"/>
<element name="TFilterComboBox.ItemIndex" link="#LCL.StdCtrls.TCustomComboBox.ItemIndex"/>
<element name="TFilterComboBox.ParentBidiMode" link="#LCL.Controls.TControl.ParentBidiMode"/>
<element name="TFilterComboBox.ParentColor" link="#LCL.Controls.TControl.ParentColor"/>
<element name="TFilterComboBox.ParentFont" link="#LCL.Controls.TControl.ParentFont"/>
<element name="TFilterComboBox.ParentShowHint" link="#LCL.Controls.TControl.ParentShowHint"/>
<element name="TFilterComboBox.PopupMenu" link="#LCL.Controls.TControl.PopupMenu"/>
<element name="TFilterComboBox.ShellListView" link="#LCL.FileCtrl.TCustomFilterComboBox.ShellListView"/>
<element name="TFilterComboBox.ShowHint" link="#LCL.Controls.TControl.ShowHint"/>
<element name="TFilterComboBox.TabOrder" link="#LCL.Controls.TWinControl.TabOrder"/>
<element name="TFilterComboBox.TabStop" link="#LCL.Controls.TWinControl.TabStop"/>
<element name="TFilterComboBox.Visible" link="#LCL.Controls.TControl.Visible"/>
<element name="TFilterComboBox.OnChange" link="#LCL.StdCtrls.TCustomComboBox.OnChange"/>
<element name="TFilterComboBox.OnClick" link="#LCL.Controls.TControl.OnClick"/>
<element name="TFilterComboBox.OnCloseUp" link="#LCL.StdCtrls.TCustomComboBox.OnCloseUp"/>
<element name="TFilterComboBox.OnContextPopup" link="#LCL.Controls.TControl.OnContextPopup"/>
<element name="TFilterComboBox.OnDblClick" link="#LCL.Controls.TControl.OnDblClick"/>
<element name="TFilterComboBox.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop"/>
<element name="TFilterComboBox.OnDragOver" link="#LCL.Controls.TControl.OnDragOver"/>
<element name="TFilterComboBox.OnEndDrag" link="#LCL.Controls.TControl.OnEndDrag"/>
<element name="TFilterComboBox.OnDropDown" link="#LCL.StdCtrls.TCustomComboBox.OnDropDown"/>
<element name="TFilterComboBox.OnEnter" link="#LCL.Controls.TWinControl.OnEnter"/>
<element name="TFilterComboBox.OnExit" link="#LCL.Controls.TWinControl.OnExit"/>
<element name="TFilterComboBox.OnKeyDown" link="#LCL.Controls.TWinControl.OnKeyDown"/>
<element name="TFilterComboBox.OnKeyPress" link="#LCL.Controls.TWinControl.OnKeyPress"/>
<element name="TFilterComboBox.OnKeyUp" link="#LCL.Controls.TWinControl.OnKeyUp"/>
<element name="TFilterComboBox.OnMouseDown" link="#LCL.Controls.TControl.OnMouseDown"/>
<element name="TFilterComboBox.OnMouseMove" link="#LCL.Controls.TControl.OnMouseMove"/>
<element name="TFilterComboBox.OnMouseUp" link="#LCL.Controls.TControl.OnMouseUp"/>
<element name="TFilterComboBox.OnStartDrag" link="#LCL.Controls.TControl.OnStartDrag"/>
<!-- property Visibility: published -->
<element name="TFilterComboBox.OnSelect">
<short/>
<descr>
</descr>
<seealso>
</seealso>
</element>
<element name="TFilterComboBox.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
<element name="MiniMizeName">
<short>Returns a shortened version of a file name, so that it fits on the given MaxWidth</short>
<descr>
<p>This function will return a shortened version of FileName, so that it fits on the given MaxWidth.
It uses the Font currently selected in the given Canvas.</p>
<p>For example: C:\Documents and Settings\User\Application Data\Microsoft\Word\custom.dic would become something like: C:\...\Word\custom.dic</p>
</descr>
</element>
<!-- function result Visibility: default -->
<element name="MiniMizeName.Result">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="MiniMizeName.FileName">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="MiniMizeName.Canvas">
<short/>
</element>
<!-- argument Visibility: default -->
<element name="MiniMizeName.MaxWidth">
<short/>
</element>
<!-- procedure Visibility: default -->
<element name="Register">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
</module>
<!-- FileCtrl -->
</package>
</fpdoc-descriptions>
|