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
|
Description: Clean up POD.
Author: Tim Retout <diocles@debian.org>
--- a/FileDialog.pm
+++ b/FileDialog.pm
@@ -58,8 +58,6 @@
=head1 SYNOPSIS
-=over 4
-
=head2 Usage Description
To use FileDialog, simply create your FileDialog objects during initialization (or at
@@ -72,10 +70,6 @@
The following code creates a FileDialog and calls it. Note that perl5.002gamma is
required.
-=over 4
-
-=item
-
#!/usr/bin/perl -w
use Tk;
@@ -127,25 +121,12 @@
exit;
-
-=back
-
-=back
-
=head1 METHODS
-=over 4
-
-=item
-
The following non-standard methods may be used with a FileDialog object
-=item
-
=head2 Show
-=over 4
-
Displays the file dialog box for the user to operate. Additional configuration
items may be passed in at Show-time In other words, this code snippet:
@@ -156,17 +137,10 @@
$fd->configure(-Title => 'Ooooh, Preeeeeety!');
$fd->Show;
-
-=back
-
-=item
-
=head2 Version
Returns the current Version of FileDialog
-=back
-
=head1 CONFIGURATION
Any of the following configuration items may be set via the configure (or Show) method,
@@ -180,24 +154,12 @@
=over 4
-=item
-
-=head2 -Chdir
-
-=over 8
-
-=item
+=item -Chdir
Enable the user to change directories. The default is 1. If disabled, the directory
list box will not be shown.
-=back
-
-=head2 -Create
-
-=over 8
-
-=item
+=item -Create
Enable the user to specify a file that does not exist. If not enabled, and the user
specifies a non-existent file, a dialog box will be shown informing the user of the
@@ -205,97 +167,47 @@
default: 1
-=back
-
-=head2 -ShowAll
-
-=over 8
-
-=item
+=item -ShowAll
Determines whether hidden files (.*) are displayed in the File and Directory Listboxes.
The default is 0. The Show All Checkbox reflects the setting of this switch.
-=back
-
-=head2 -DisableShowAll
-
-=over 8
-
-=item
+=item -DisableShowAll
Disables the ability of the user to change the status of the ShowAll flag. The default
is 0 (the user is by default allowed to change the status).
-=back
-
-=head2 -Grab
-
-=over 8
-
-=item
+=item -Grab
Enables the File Dialog to do an application Grab when displayed. The default is 1.
-=back
-
-=head2 -Horiz
-
-=over 8
-
-=item
+=item -Horiz
True sets the File List box to be to the right of the Directory List Box. If 0, the
File List box will be below the Directory List box. The default is 1.
-=back
-
-=head2 -SelDir
-
-=over 8
-
-=item
+=item -SelDir
If True, enables selection of a directory rather than a file, and disables the
actions of the File List Box. The default is 0.
=back
-=back
-
=head2 I<Special>
=over 4
-=item
-
-=head2 -FPat
-
-=over 8
-
-=item
+=item -FPat
Sets the default file selection pattern. The default is '*'. Only files matching
this pattern will be displayed in the File List Box.
-=back
-
-=head2 -Geometry
-
-=over 8
-
-=item
+=item -Geometry
Sets the geometry of the File Dialog. Setting the size is a dangerous thing to do.
If not configured, or set to '', the File Dialog will be centered.
-=back
-
-=head2 -SelHook
-
-=over 8
-
-=item
+=item -SelHook
SelHook is configured with a reference to a routine that will be called when a file
is chosen. The file is called with a sole parameter of the full path and file name
@@ -316,8 +228,6 @@
=back
-=back
-
=head2 I<Strings>
The following two switches may be used to set default variables, and to get final
@@ -326,11 +236,13 @@
=over 4
-=item
+=item -File
+
+The file selected, or the default file. The default is ''.
-B<-File> The file selected, or the default file. The default is ''.
+=item -Path
-B<-Path> The path of the selected file, or the initial path. The default is $ENV{'HOME'}.
+The path of the selected file, or the initial path. The default is $ENV{'HOME'}.
=back
@@ -341,21 +253,33 @@
=over 4
-=item
+=item -Title
+
+The Title of the dialog box. The default is 'Select File:'.
+
+=item -DirLBCaption
-B<-Title> The Title of the dialog box. The default is 'Select File:'.
+The Caption above the Directory List Box. The default is 'Directories'.
-B<-DirLBCaption> The Caption above the Directory List Box. The default is 'Directories'.
+=item -FileLBCaption
-B<-FileLBCaption> The Caption above the File List Box. The default is 'Files'.
+The Caption above the File List Box. The default is 'Files'.
-B<-FileEntryLabel> The label to the left of the File Entry. The Default is 'Filename:'.
+=item -FileEntryLabel
-B<-PathEntryLabel> The label to the left of the Path Entry. The default is 'Pathname:'.
+The label to the left of the File Entry. The Default is 'Filename:'.
-B<-FltEntryLabel> The label to the left of the Filter entry. The default is 'Filter:'.
+=item -PathEntryLabel
-B<-ShowAllLabel> The text of the Show All Checkbutton. The default is 'Show All'.
+The label to the left of the Path Entry. The default is 'Pathname:'.
+
+=item -FltEntryLabel
+
+The label to the left of the Filter entry. The default is 'Filter:'.
+
+=item -ShowAllLabel
+
+The text of the Show All Checkbutton. The default is 'Show All'.
=back
@@ -365,13 +289,17 @@
=over 4
-=item
+=item -OKButtonLabel
+
+The text for the OK button. The default is 'OK'.
-B<-OKButtonLabel> The text for the OK button. The default is 'OK'.
+=item -RescanButtonLabel
-B<-RescanButtonLabel> The text for the Rescan button. The default is 'Rescan'.
+The text for the Rescan button. The default is 'Rescan'.
-B<-CancelButtonLabel> The text for the Cancel button. The default is 'Cancel'.
+=item -CancelButtonLabel
+
+The text for the Cancel button. The default is 'Cancel'.
=back
@@ -383,23 +311,11 @@
=over 4
-=item
-
-=head2 -EDlgTitle
-
-=over 8
-
-=item
+=item -EDlgTitle
The title of the Error Dialog Box. The default is 'File does not exist!'.
-=back
-
-=head2 -EDlgText
-
-=over 8
-
-=item
+=item -EDlgText
The message of the Error Dialog Box. The variables $path, $file, and $filename
(the full path and filename of the selected file) are available. The default
@@ -407,8 +323,6 @@
=back
-=back
-
=head1 Author
B<Brent B. Powers, Merrill Lynch (B2Pi)>
|