From 1cf6dd7b5e03e7c7b126d660296512c72f16a745 Mon Sep 17 00:00:00 2001 From: Dmitry Karasik Date: Mon, 9 Oct 2023 22:42:29 +0200 Subject: [PATCH] polish the pod context --- Prima/Dialog/ColorDialog.pm | 71 +++++++++++----------- Prima/Dialog/FileDialog.pm | 116 +++++++++++++++++------------------- Prima/Dialog/FindDialog.pm | 46 +++++++------- Prima/Dialog/FontDialog.pm | 17 +++--- Prima/Dialog/ImageDialog.pm | 75 ++++++++++++----------- Prima/Dialog/PrintDialog.pm | 22 +++---- 6 files changed, 170 insertions(+), 177 deletions(-) diff --git a/Prima/Dialog/ColorDialog.pm b/Prima/Dialog/ColorDialog.pm index 538842927..64cc8b3f9 100644 --- a/Prima/Dialog/ColorDialog.pm +++ b/Prima/Dialog/ColorDialog.pm @@ -116,7 +116,7 @@ sub create_wheel my ( $y1, $x1) = ($id,$id); my $d0 = $id / 2; - my $i = Prima::Image->create( + my $i = Prima::Image->new( width => $id, height => $id, type => im::RGB, @@ -137,7 +137,7 @@ sub create_wheel $i-> scaling( ist::Gaussian ) if $::application->get_bpp > 8; $i-> size( 256 * $pix, 256 * $pix); - my $xa = Prima::DeviceBitmap-> create( + my $xa = Prima::DeviceBitmap-> new( width => 256 * $pix, height => 256 * $pix, name => 'ColorWheel', @@ -169,7 +169,7 @@ sub create_wheel_shape return unless $shapext; my ($id, $pix) = @_; my $imul = 256 * $pix / $id; - my $a = Prima::Image-> create( + my $a = Prima::Image-> new( width => 256 * $pix, height => 256 * $pix, type => im::BW, @@ -931,7 +931,7 @@ sub MoreBtn_Click my ($combo,$self) = @_; my $d; $combo-> listVisible(0); - $d = Prima::Dialog::ColorDialog-> create( + $d = Prima::Dialog::ColorDialog-> new( text => 'Mixed color palette', value => $combo-> value, grayscale => $combo->grayscale, @@ -1043,7 +1043,7 @@ Prima::Dialog::ColorDialog - standard color selection facilities use Prima qw(Dialog::ColorDialog Application); - my $p = Prima::Dialog::ColorDialog-> create( + my $p = Prima::Dialog::ColorDialog-> new( quality => 1, ); printf "color: %06x", $p-> value if $p-> execute == mb::OK; @@ -1055,9 +1055,9 @@ Prima::Dialog::ColorDialog - standard color selection facilities =head1 DESCRIPTION The module contains two packages, C and C, -used as standard tools for interactive color selection. C is -a modified combo widget, which provides selecting from predefined palette but also can -invoke C window. +used as standard tools for the interactive color selection. C is +a modified combo widget that provides selecting colors from a predefined palette, but also can +invoke a C window. =head1 Prima::Dialog::ColorDialog @@ -1067,17 +1067,17 @@ invoke C window. =item grayscale BOOLEAN -If set, allows only gray colors for selection +If set, allows only gray colors =item quality BOOLEAN -Used to increase visual quality of the dialog if run on paletted displays. +The setting can increase the visual quality of the dialog if run on paletted displays. Default value: 0 =item value COLOR -Selects the color, represented by the color wheel and other dialog controls. +Selects the color represented by the color wheel and other dialog controls. Default value: C @@ -1089,7 +1089,7 @@ Default value: C =item hsv2rgb HUE, SATURATION, LUMINOSITY -Converts color from HSV to RGB format and returns three integer values, red, green, +Converts a color from HSV to RGB format and returns three 8-bit integer values, red, green, and blue components. =item rgb2hsv RED, GREEN, BLUE @@ -1101,24 +1101,24 @@ and luminosity components. Maps X and Y coordinate values onto a color wheel with RADIUS in pixels. The code uses RADIUS = 119 for mouse position coordinate mapping. -Returns three values, - hue, saturation and error flag. If error flag -is set, the conversion has failed. +Returns three values, - hue, saturation, and error flag. If the error flag +is set, the conversion is failed. =item hs2xy HUE, SATURATION -Maps hue and saturation onto 256-pixel wide color wheel, and +Maps hue and saturation onto a 256-pixel wide color wheel, and returns X and Y coordinates of the corresponding point. =item create_wheel SHADES, BACK_COLOR -Creates a color wheel with number of SHADES given, -drawn on a BACK_COLOR background, and returns a C object. +Creates a color wheel with the number of SHADES given, +drawn on a BACK_COLOR background. Returns a C object. =item create_wheel_shape SHADES -Creates a circular 1-bit mask, with radius derived from SHAPES. -SHAPES must be same as passed to L. -Returns C object. +Creates a circular 1-bit mask with a radius derived from SHAPES. +SHAPES must be the same as passed to L. +Returns a C object. =back @@ -1128,9 +1128,10 @@ Returns C object. =item BeginDragColor $PROPERTY -Called when the user starts dragginh a color from the color wheel by with left -mouse button and combination of Alt, Ctrl, and Shift keys. $PROPERTY is one -of C color properties, and depends on combination of keys: +Called when the user starts dragging a color from the color wheel by the left +mouse button and an optional combination of Alt, Ctrl, and Shift keys. +$PROPERTY is one of the C color properties, and depends on +a combination of the following keys: Alt backColor Ctrl color @@ -1139,17 +1140,17 @@ of C color properties, and depends on combination of keys: Ctrl+Alt disabledColor Ctrl+Alt+Shift disabledBackColor -Default action reflects the property to be changes in the dialog title +The default action reflects the property to be changed in the dialog title =item Change The notification is called when the L property is changed, either -interactively or as a result of direct call. +interactively or as a result of a direct call. =item EndDragColor $PROPERTY, $WIDGET -Called when the user releases the mouse drag over a Prima widget. -Default action sets C<< $WIDGET->$PROPERTY >> to the current color value. +Called when the user releases the mouse button over a Prima widget. +The default action sets C<< $WIDGET->$PROPERTY >> to the selected color value. =back @@ -1159,11 +1160,11 @@ Default action sets C<< $WIDGET->$PROPERTY >> to the current color value. =item $colorWheel -Contains cached result of L call. +Contains the cached result of the L method. =item $colorWheelShape -Contains cached result of L call. +Contains the cached result of the L method. =back @@ -1175,9 +1176,9 @@ Contains cached result of L call. =item Colorify INDEX, COLOR_PTR -C callback, designed to map combo palette index into a RGB color. -INDEX is an integer from 0 to L - 1, COLOR_PTR is a reference to a -result scalar, where the notification is expected to write the resulting color. +C callback, designed to map combo palette index into an RGB color. +INDEX is an integer from 0 to L - 1, COLOR_PTR is a reference to the +result scalar where the notification is expected to store the resulting color. =back @@ -1187,15 +1188,15 @@ result scalar, where the notification is expected to write the resulting color. =item colors INTEGER -Defines amount of colors in the fixed palette of the combo box. +Defines the amount of colors in the fixed palette of the combo box. =item grayscale BOOLEAN -If set, allows only gray colors for selection +If set, allows only gray colors =item value COLOR -Contains the color selection as 24-bit integer value. +Contains the color selection as a 24-bit integer value. =back diff --git a/Prima/Dialog/FileDialog.pm b/Prima/Dialog/FileDialog.pm index 97e684226..6cdbb109e 100644 --- a/Prima/Dialog/FileDialog.pm +++ b/Prima/Dialog/FileDialog.pm @@ -1740,11 +1740,11 @@ sub showDotDirs =head1 NAME -Prima::Dialog::FileDialog - File system-related widgets and dialogs. +Prima::Dialog::FileDialog - File system-related widgets and dialogs =head1 SYNOPSIS -# open a file + # open file use Prima qw(Application Dialog::FileDialog); my $open = Prima::Dialog::OpenDialog-> new( @@ -1755,7 +1755,7 @@ Prima::Dialog::FileDialog - File system-related widgets and dialogs. ); print $open-> fileName, " is to be opened\n" if $open-> execute; - # save a file + # save file my $save = Prima::Dialog::SaveDialog-> new( fileName => $open-> fileName, ); @@ -1771,15 +1771,13 @@ Prima::Dialog::FileDialog - File system-related widgets and dialogs. =head1 DESCRIPTION -The module contains widgets for file and drive selection, -and also standard open file, save file, and change directory -dialogs. +The module contains standard open file, save file, and change directory +dialogs; plus special widgets for file and drive selection that are used in the +dialogs =head1 Prima::DirectoryListBox -A directory listing list box. Shows the list of -subdirectories and upper directories, hierarchy-mapped, -with the folder images and outlines. +A directory list box. Shows the list of subdirectories. =head2 Properties @@ -1787,46 +1785,43 @@ with the folder images and outlines. =item closedGlyphs INTEGER -Number of horizontal equal-width images, contained in L +The number of horizontal equal-width images, contained in the L property. Default value: 1 =item closedIcon ICON -Provides an icon representation -for the directories, contained in the current directory. +Provides the icon +for the directories contained in the current directory. =item indent INTEGER -A positive integer number of pixels, used for offset of +A positive integer number of pixels, the offset of the hierarchy outline. Default value: 12 =item openedGlyphs INTEGER -Number of horizontal equal-width images, contained in L +The number of horizontal equal-width images, contained in the L property. Default value: 1 =item openedIcon OBJECT -Provides an icon representation -for the directories, contained in the directories above the current -directory. +Provides the icon for the directories contained above the current directory. =item path STRING -Runtime-only property. Selects a file system path. +Runtime-only property. Selects the file path. =item showDotDirs BOOLEAN -Selects if the directories with the first dot character -are shown the view. The treatment of the dot-prefixed names -as hidden is traditional to unix, and is of doubtful use under -win32. +Selects if the directories with the first dot character are shown. The +dot-prefixed files are traditionally hidden in unix, so under Windows, this +property is not useful. Default value: 1 @@ -1836,18 +1831,16 @@ Default value: 1 =over -=item files [ FILE_TYPE ] +=item files FILE_TYPE -If FILE_TYPE value is not specified, the list of all files in the -current directory is returned. If FILE_TYPE is given, only the files -of the types are returned. The FILE_TYPE is a string, one of those -returned by C ( see L. +Returns the list of files filtered by FILE_TYPE. The FILE_TYPE is a string, +one of those returned by C ( see L. =back =head1 Prima::DriveComboBox -Provides drive selection combo-box for non-unix systems. +Drive selector combo-box for non-unix systems =head2 Properties @@ -1859,9 +1852,9 @@ Create-only property. Default value: 'A:' -DRIVE_LETTER can be set to other value to start the drive enumeration from. +DRIVE_LETTER can be set to another value to start the drive enumeration. Some OSes can probe eventual diskette drives inside the drive enumeration -routines, so it might be reasonable to set DRIVE_LETTER to C string +routines, so it might be reasonable to set DRIVE_LETTER to the C string for responsiveness increase. =item drive DRIVE_LETTER @@ -1874,12 +1867,12 @@ Default value: 'C:' =head1 Prima::Dialog::FileDialog -Provides a standard file dialog, allowing to navigate by the -file system and select one or many files. The class can -operate in two modes - 'open' and 'save'; these modes are -set by L and L. -Some properties behave differently depending on the mode, -which is stored in L property. +Provides the standard file dialog where the user can navigate in the file +system and select one or many files. The class can operate in two modes - +'open' and 'save'; these modes are triggered internally by +L and L. Some properties +behave differently depending on the mode that is stored in the L +property. =head2 Properties @@ -1887,7 +1880,7 @@ which is stored in L property. =item createPrompt BOOLEAN -If 1, and a file selected is nonexistent, asks the user +If 1, and the selected file is nonexistent, asks the user if the file is to be created. Only actual when L is 1. @@ -1903,7 +1896,7 @@ Default value: '' =item directory STRING -Selects the currently selected directory. +Selects the currently selected directory =item fileMustExist BOOLEAN @@ -1914,23 +1907,22 @@ Default value: 1 =item fileName STRING, ... -For single-file selection, assigns the selected file name, -For multiple-file selection, on get-call returns list of the selected -files; on set-call, accepts a single string, where the file names -are separated by the space character. The eventual space characters -must be quoted. +For the single-file selection, assigns the selected file name. For the +multiple-file selection, on get-calls returns a list of the selected files; on +set-calls accepts a single string where the file names are separated by the +space character. The eventual space characters must be quoted. =item filter ARRAY -Contains array of arrays of string pairs, where each pair describes +Contains an array of arrays of string pairs, where each pair describes a file type. The first scalar in the pair is the description of the type; the second is a file mask. -Default value: [[ 'All files' => '*']] +Default value: C<< [[ 'All files' => '*']] >> =item filterIndex INTEGER -Selects the index in L array of the currently selected file type. +Selects the index in the L array, which is the currently selected file type. =item multiSelect BOOLEAN @@ -1948,7 +1940,7 @@ Only actual when L is 0. =item noTestFileCreate BOOLEAN -If 0, tests if a file selected can be created. +If 0, tests if a file that the user selected can be created. Default value: 0 @@ -1956,7 +1948,7 @@ Only actual when L is 0. =item overwritePrompt BOOLEAN -If 1, asks the user if the file selected is to be overwrittten. +If 1, asks the user if the file selected is to be overwritten. Default value: 1 @@ -1971,7 +1963,7 @@ mode. =item pathMustExist BOOLEAN -If 1, ensures that the path, types by the user, exists before +If 1, ensures that the path typed by the user exists before closing the dialog. Default value: 1 @@ -1979,15 +1971,15 @@ Default value: 1 =item showDotFiles BOOLEAN Selects if the directories with the first dot character -are shown the files view. +are shown. Default value: 0 =item showHelp BOOLEAN -Create-only property. If 1, 'Help' button is inserted in the dialog. +A create-only property. If 1, the 'Help' button is inserted in the dialog. -Default value: 1 +Default value: 0 =item sorted BOOLEAN @@ -1997,13 +1989,13 @@ Default value : 1 =item system BOOLEAN -Create-only property. If set to 1, C returns -instance of C system-specific file dialog, +A create-only property. If set to 1, C returns +an instance of the C system-specific file dialog, if available for the I platform. -C knows only how to map C, C, and C -classes onto the system-specific file dialog classes; the inherited classes -are not affected. +The C property knows only how to map the C, C, and +C classes onto the system-specific file dialog classes; the +inherited classes are not affected and cannot be replaced by the system dialog. =back @@ -2019,11 +2011,11 @@ Re-reads the currently selected directory. =head1 Prima::Dialog::OpenDialog -Descendant of L, tuned for open-dialog functionality. +A descendant of L tuned for open-dialog functionality. =head1 Prima::Dialog::SaveDialog -Descendant of L, tuned for save-dialog functionality. +A descendant of L tuned for save-dialog functionality. =head1 Prima::Dialog::ChDirDialog @@ -2040,15 +2032,15 @@ Selects the directory =item showDotDirs Selects if the directories with the first dot character -are shown the view. +are shown Default value: 0 =item showHelp -Create-only property. If 1, 'Help' button is inserted in the dialog. +Create-only property. If 1, the 'Help' button is inserted in the dialog. -Default value: 1 +Default value: 0 =back diff --git a/Prima/Dialog/FindDialog.pm b/Prima/Dialog/FindDialog.pm index cec93fe50..249849d58 100644 --- a/Prima/Dialog/FindDialog.pm +++ b/Prima/Dialog/FindDialog.pm @@ -242,20 +242,20 @@ sub profile_default =head1 NAME -Prima::Dialog::FindDialog - wrapper module for Prima::Dialog::FindDialog and -Prima::Dialog::ReplaceDialog to find and replace text. +Prima::Dialog::FindDialog - the standard dialogs FindDialog and ReplaceDialog +to find and replace text =head1 SYNOPSIS use Prima qw(Dialog::FindDialog Application); - my $dlg = Prima::Dialog::FindDialog-> create( findStyle => 0); + my $dlg = Prima::Dialog::FindDialog-> new( findStyle => 0); my $res = $dlg-> execute; if ( $res == mb::Ok) { print $dlg-> findText, " is to be found\n"; } elsif ( $res == mb::ChangeAll) { print "all occurrences of ", $dlg-> findText, - " is to be replaced by ", $dlg-> replaceText; + " are to be replaced by ", $dlg-> replaceText; } =for podview @@ -264,24 +264,26 @@ Prima::Dialog::ReplaceDialog to find and replace text. =head1 DESCRIPTION -The module provides two classes - Prima::Dialog::FindDialog and Prima::Dialog::ReplaceDialog; -Prima::Dialog::ReplaceDialog is exactly same as Prima::Dialog::FindDialog except that -its default L property value is set to 0. One can use a dialog-caching -technique, arbitrating between L value 0 and 1, and use only one -instance of Prima::Dialog::FindDialog. +The module provides two classes Prima::Dialog::FindDialog and +Prima::Dialog::ReplaceDialog. The Prima::Dialog::ReplaceDialog class is the same +as Prima::Dialog::FindDialog except that its default L property +value is set to 0. One can cache and reuse the dialog object, changing its +L value to 0 and 1, so that only one instance of +Prima::Dialog::FindDialog is used in the program. -The module does not provide the actual search algorithm; this must be implemented -by the programmer. The toolkit currently include some facilitation to the problem - -the part of algorithm for C class is found in L, -and the another part - in F example program. L -also uses the module, and realizes its own searching algorithm. +The module does not provide the actual search algorithm; this must be +implemented by the programmer. The toolkit includes some help - the part of +the algorithm for the C class is implemented in the C +method, and another part in the F example program. The +L class also uses the module but implements its own +searching algorithm. =head1 API =head2 Properties -All the properties select the user-assigned values, except -L. +All the properties reflect values that the user can change interactively, - +except L. =over @@ -293,14 +295,14 @@ Default value: '' =item findStyle BOOLEAN -If 1, the dialog provides only 'find text' interface. If 0, -the dialog provides also 'replace text' interface. +If 1, the dialog provides only the 'find text' interface. If 0, the dialog provides +also the'replace text' interface. Default value: 1 for C, 0 for C. =item options INTEGER -Combination of C constants. For the detailed description see L. +A combination of the C constants. For the detailed description see L. fdo::MatchCase fdo::WordsOnly @@ -312,14 +314,14 @@ Default value: 0 =item replaceText STRING -Selects the text string that is to replace the found text. +Selects the text string to replace the found text. Default value: '' =item scope -One of C constants. Represents the scope of the search: it can be started -from the cursor position, of from the top or of the bottom of the text. +One of the C constants. Represents the scope of the search: it can be started +from the cursor position, from the top of the text, or from the bottom. fds::Cursor fds::Top diff --git a/Prima/Dialog/FontDialog.pm b/Prima/Dialog/FontDialog.pm index 4868a2044..b89c09d40 100644 --- a/Prima/Dialog/FontDialog.pm +++ b/Prima/Dialog/FontDialog.pm @@ -464,8 +464,8 @@ Prima::Dialog::FontDialog - standard font dialog =head1 DESCRIPTION -The dialog provides selection of font by name, style, size, and encoding. -The font selected is returned by L property. +The dialog provides standard font selection by name, style, size, and encoding. +The selected font is returned by the L property. =head1 API @@ -487,13 +487,13 @@ FONT format is fully compatible with C. =item sampleText STRING -Sample line of text featuring current font selection. +Sample line of text drawn with the currently selected font Default value: AaBbYyZz =item showHelp BOOLEAN -Create-only property. +A create-only property. Specifies if the help button is displayed in the dialog. @@ -508,18 +508,17 @@ Default value: 0 =item BeginDragFont Called when the user starts dragging a font from the font sample widget by -left mouse button. +the left mouse button. -Default action reflects the status in the dialog title +The default action reflects the dragging status in the dialog title =item EndDragFont $WIDGET -Called when the user releases the mouse drag over a Prima widget. -Default action applies currently selected font to $WIDGET. +Called when the user releases the mouse button over a Prima widget. +The default action applies the currently selected font to $WIDGET. =back - =head1 AUTHOR Dmitry Karasik, Edmitry@karasik.eu.orgE. diff --git a/Prima/Dialog/ImageDialog.pm b/Prima/Dialog/ImageDialog.pm index da6c14669..0711769a4 100644 --- a/Prima/Dialog/ImageDialog.pm +++ b/Prima/Dialog/ImageDialog.pm @@ -523,22 +523,21 @@ EXIT: =head1 NAME -Prima::Dialog::ImageDialog - file open and save dialogs. +Prima::Dialog::ImageDialog - image file open and save dialogs =head1 DESCRIPTION -The module provides dialogs specially adjusted for image +The module provides standard dialogs specially adjusted for image loading and saving. =head1 Prima::Dialog::ImageOpenDialog -Provides a preview feature, allowing the user to view the image file before +Provides a preview widget, allowing the user to view the image file before loading, and the selection of a frame index for the multi-framed image files. -Instead of C call, the L method is used to invoke the dialog and -returns the loaded image as a C object. The loaded object by -default contains C<{extras}> hash variable set, which contains extra -information returned by the loader. See L for more -information. +Instead of the C call, the L method is used to invoke the dialog +and returns the loaded image as a C object. The loaded object +contains the C<{extras}> hash with the file and image information filled by the +loader. See L for more information. =head2 SYNOPSIS @@ -552,7 +551,7 @@ information. =for html

-=head2 Proprties +=head2 Properties =over @@ -573,19 +572,19 @@ Default value: 1 Executes the dialog, and, if successful, loads the image file and frame selected by the user. Returns the loaded image as a C object. -PROFILE is a hash, passed to C method. In particular, it -can be used to disable the default loading of extra information in C<{extras}> -variable, or to specify a non-default loading option. For example, -C<{extras}-E{className} = 'Prima::Icon'> would return the loaded image as -an icon object. See L for more. +PROFILE is a hash, passed to the C method. In particular, +it can be used to disable the default loading of extra information in the +C<{extras}> hash variable or to specify a non-default loading option. For +example, C<< {extras}->{className} = 'Prima::Icon' >> would return the +loaded image as an icon object. See L for more. -C can report progressive image loading to the caller, and/or to an +C can report the progress of the image loading to the caller, and/or to an instance of C, if desired. If either (or both) C and C notifications are specified, these are called from the respective event handlers of the image being loaded ( see L for details). If -profile key C is supplied, its value is treated as a -C instance, and it is used to display image loading +the profile key C is supplied, its value is treated as a +C instance, and it is used to display the loading progress. See L. =back @@ -606,20 +605,20 @@ See L. =head1 Prima::Dialog::ImageSaveDialog -Provides a save dialog where the user can select image format, -the bit depth and other format-specific options. The format-specific -options can be set if a dialog for the file format is provided. -The standard toolkit dialogs reside under in C namespace, -in F subdirectory. For example, C provides -the selection of transparency color, and C the image -quality control. If the image passed to the L property contains -C<{extras}> variable, the data are read and used as the default values. -In particular, C<{extras}-E-{codecID}> field, responsible for the -file format, if present, affects the default file format selection. +Provides the standard image save dialog where the user can select the desired +image format, the bit depth, and other format-specific options. The +format-specific options can be set if a dialog for the file format is provided +by the toolkit. The standard toolkit dialogs reside under the C +namespace, in the F subdirectory. For example, +C provides the selection of a transparent color, and +C provides the image quality control. If the image passed +to the L property contains the C<{extras}> hash variable, its data are used +as the default values. In particular, the C<< {extras}->{codecID} >> field, +responsible for the file format, affects the default file format selection. =head2 SYNOPSIS - my $dlg = Prima::Dialog::ImageSaveDialog-> create; + my $dlg = Prima::Dialog::ImageSaveDialog-> new; return unless $dlg-> save( $image ); print "saved as ", $dlg-> fileName, "\n"; @@ -629,9 +628,9 @@ file format, if present, affects the default file format selection. =item image IMAGE -Selects the image to be saved. This property is to be used -for the standard invocation of dialog, via C. It is not -needed when the execution and saving is invoked via L method. +Selects the image to be saved. The property is to be used +for the standard invocation of dialog, via the C method. It is not +needed when the execution and saving are invoked via the L method. =back @@ -641,13 +640,13 @@ needed when the execution and saving is invoked via L method. =item save IMAGE, %PROFILE -Invokes the dialog, and, if the execution was successful, saves -the IMAGE according to the user selection and PROFILE hash. -PROFILE is not used for the default options, but is passed -directly to C call, possibly overriding -selection of the user. -Returns 1 in case of success, 0 in case of error. -If the error occurs, the user is notified before the method returns. +Invokes the dialog, and, if the execution is successful, saves the IMAGE +according to the user selection and PROFILE hash. PROFILE is not used as a +source of the default options, but is passed directly to the +C call, possibly overriding the selection of the user. + +Returns 1 on success, 0 on error. If the error occurs, the +user is notified before the method returns. =back diff --git a/Prima/Dialog/PrintDialog.pm b/Prima/Dialog/PrintDialog.pm index 02145cfb1..5a6eafcb2 100644 --- a/Prima/Dialog/PrintDialog.pm +++ b/Prima/Dialog/PrintDialog.pm @@ -178,17 +178,17 @@ Prima::Dialog::PrintDialog - standard printer setup dialog =head1 DESCRIPTION -Provides a standard dialog that allows the user to select a printer -and its options. The toolkit does not provide the in-depth management -of the printer options; this can only be accessed by executing a printer-specific -setup window, called by C. The class invokes -this method when the user presses 'Properties' button. Otherwise, the class -provides only selection of a printer from the printer list. - -When the dialog finished successfully, the selected printer is set as the current -by writing to C property. This technique allows direct use of -the user-selected printer and its properties without prior knowledge of the -selection process. +Provides the standard dialog that allows the user to select the printer and its +options. The toolkit does not provide the in-depth management of the printer +options; this can only be accessed by executing the printer-specific setup +window, called by the C method. The class invokes +this method when the user presses the 'Properties' button. Otherwise the class +provides only selection from the printer list. + +When the dialog finishes successfully the selected printer is set as current by +setting the C property. This technique allows direct +use of the user-selected printer and its properties without prior knowledge of +the selection process. =head1 SYNOPSIS