Skip to content

Commit

Permalink
polish the pods
Browse files Browse the repository at this point in the history
  • Loading branch information
dk committed Oct 15, 2023
1 parent 7f93824 commit 63dc672
Show file tree
Hide file tree
Showing 8 changed files with 518 additions and 546 deletions.
40 changes: 20 additions & 20 deletions Prima/Calendar.pm
Original file line number Diff line number Diff line change
Expand Up @@ -542,10 +542,10 @@ Prima::Calendar - standard calendar widget
=head1 DESCRIPTION
Provides interactive selection of date between 1900 and 2099 years.
The main property, L<date>, is a three-integer array, day, month, and year,
Provides interactive selection for dates between the years 1900 and 2099.
The main property, L<date>, is a three-integer array of day, month, and year,
in the format of perl localtime ( see L<perlfunc/localtime> ) -
day can be in range from 1 to 31,month from 0 to 11, year from 0 to 199.
day's range is between 1 and 31, month's 0 to 11, year's from 0 to 199.
=head1 API
Expand All @@ -565,30 +565,30 @@ Called when the L<date> property is changed.
=item date DAY, MONTH, YEAR
Accepts three integers in format of C<localtime>.
Accepts three integers in the format of C<localtime>.
DAY can be from 1 to 31, MONTH from 0 to 11, YEAR from 0 to 199.
Default value: today's date.
=item day INTEGER
Selects the day in month.
Selects the day in the month.
=item firstDayOfWeek INTEGER
Selects the first day of week, an integer between 0 and 6,
where 0 is Sunday is the first day, 1 is Monday etc.
Selects the first day of the week, an integer between 0 and 6,
where 0 is Sunday as the first day, 1 is Monday, etc.
Default value: 0
=item month
Selects the month.
Selects the month
=item useLocale BOOLEAN
If 1, the locale-specific names of months and days of week are used.
These are read by calling C<POSIX::strftime>. If invocation of POSIX module
These are read by calling C<POSIX::strftime>. If an invocation of the POSIX module
fails, the property is automatically assigned to 0.
If 0, the English names of months and days of week are used.
Expand All @@ -609,34 +609,34 @@ Selects the year.
=item can_use_locale
Returns boolean value, whether the locale information can be retrieved
by calling C<strftime>.
Returns a boolean value, whether the locale information can be retrieved
by calling C<strftime> or not.
=item month2str MONTH
Returns MONTH name according to L<useLocale> value.
Returns the MONTH name according to the L<useLocale> value.
=item make_months
Returns array of 12 month names according to L<useLocale> value.
Returns an array of the 12 month names according to the L<useLocale> value.
=item day_of_week DAY, MONTH, YEAR, [ USE_FIRST_DAY_OF_WEEK = 1 ]
Returns integer value, from 0 to 6, of the day of week on
DAY, MONTH, YEAR date. If boolean USE_FIRST_DAY_OF_WEEK is set,
the value of C<firstDayOfWeek> property is taken into the account,
so 0 is a Sunday shifted forward by C<firstDayOfWeek> days.
Returns an integer value between 0 and 6, the day of week on DAY, MONTH, YEAR
date. If boolean USE_FIRST_DAY_OF_WEEK is set, the value of the
C<firstDayOfWeek> property is taken into account, so f ex the result of 0 means
that this is a Sunday shifted forward by C<firstDayOfWeek> days.
The switch from Julian to Gregorian calendar is ignored.
The switch from the Julian to the Gregorian calendar is ignored.
=item date_as_string [ DAY, MONTH, YEAR ]
Returns string representation of date on DAY, MONTH, YEAR according
to L<useLocale> property value.
to the L<useLocale> property value.
=item date_from_time SEC, MIN, HOUR, M_DAY, MONTH, YEAR, ...
Copies L<date> from C<localtime> or C<gmtime> result. This helper method
Copies L<date> from C<localtime> or C<gmtime> results. This helper method
allows the following syntax:
$calendar-> date_from_time( localtime( time));
Expand Down
4 changes: 2 additions & 2 deletions Prima/Classes.pm
Original file line number Diff line number Diff line change
Expand Up @@ -2653,8 +2653,8 @@ Prima::Classes - binder module for the built-in classes.
=head1 DESCRIPTION
C<Prima::Classes> and L<Prima::Const> is a minimal set of perl modules needed for
the toolkit. Since the module provides bindings for the core classes, it is required
C<Prima::Classes> and L<Prima::Const> form a minimal set of perl modules needed for
the toolkit to run. Since the module provides bindings for the core classes, it is required
to be included in every Prima-related module and program.
=head1 AUTHOR
Expand Down
91 changes: 45 additions & 46 deletions Prima/ComboBox.pm
Original file line number Diff line number Diff line change
Expand Up @@ -767,22 +767,22 @@ Prima::ComboBox - standard combo box widget
=head1 DESCRIPTION
Provides a combo box widget which consists of an input line, list box of possible
selections and eventual drop-down button. The combo box can be either in form
with a drop-down selection list, that is shown by the command of the user,
or in form when the selection list is always visible.
The combo box is a grouping widget, and contains neither painting nor user-input
code. All such functionality is delegated into the children widgets: input line, list
box and button. C<Prima::ComboBox> exports a fixed list of methods and properties from
namespaces of L<Prima::InputLine> and L<Prima::ListBox>. Since, however, it is
possible to tweak the C<Prima::ComboBox> ( using its L<editClass> and L<listClass>
create-only properties ) so the input line and list box would be other classes,
it is not necessarily that all default functionality would work.
The list of exported names is stored in package variables %listProps, %editProps
and %listDynas. These also described in L<Exported names> section.
The module defines C<cs::> package for the constants used by L<style> property.
Provides a combo box widget that consists of an input line, a list box of
possible selections, and an eventual drop-down button. The combo box can be
either in the form of a drop-down list that can be shown and hidden or in a
form where the selection list is always visible.
The combo box is a grouping widget and contains neither painting nor
user input code by itself. All such functionality is delegated to the children
widgets: input line, list box, and drop button. C<Prima::ComboBox> exports a
fixed list of methods and properties from the namespaces of L<Prima::InputLine> and
L<Prima::ListBox>. It is possible to tweak the C<Prima::ComboBox> ( using its
L<editClass> and L<listClass> create-only properties ) so the input line and
list box widgets can be instantiated from other classes. The list of exported
names is stored in package variables %listProps, %editProps, and %listDynas.
These are also described in the L<Exported names> section.
The module defines the C<cs::> package for the constants used by the L<style> property.
=head1 API
Expand All @@ -793,27 +793,27 @@ The module defines C<cs::> package for the constants used by L<style> property.
=item autoHeight BOOLEAN
If 1, adjusts the height of the widget automatically when its font changes.
Only when style is not C<cs::Simple>.
Only for styles not equal to C<cs::Simple>.
Default value: 1
=item buttonClass STRING
Assigns a drop-down button class.
Assigns the drop-down button class.
Create-only property.
Default value: C<Prima::Widget>
=item buttonDelegations ARRAY
Assigns a drop-down button list of delegated notifications.
Assigns the list of delegated notifications to the drop-down button.
Create-only property.
=item buttonProfile HASH
Assigns hash of properties, passed to the drop-down button during the creation.
Assigns a hash of properties passed to the drop-down button during the creation.
Create-only property.
Expand All @@ -826,99 +826,99 @@ Default value: 0
=item editClass STRING
Assigns an input line class.
Assigns the input line class.
Create-only property.
Default value: C<Prima::InputLine>
=item editProfile HASH
Assigns hash of properties, passed to the input line during the creation.
Assigns a hash of properties passed to the input line during the creation.
Create-only property.
=item editDelegations ARRAY
Assigns an input line list of delegated notifications.
Assigns the list of delegated notifications to the input line.
Create-only property.
=item editHeight INTEGER
Selects height of an input line.
Selects the height of the input line.
=item items ARRAY
Mapped onto the list widget's C<items> property. See L<Prima::Lists> for details.
Proxy of the list widget's C<items> property. See L<Prima::Lists> for details.
=item listClass STRING
Assigns a listbox class.
Assigns the list box class.
Create-only property.
Default value: C<Prima::ListBox>
=item listHeight INTEGER
Selects height of the listbox widget.
Selects the height of the list box widget.
Default value: 100
=item listVisible BOOLEAN
Sets whether the listbox is visible or not. Not writable
when L<style> is C<cs::Simple>.
Sets whether the list box is visible or not. Not writable
when the C<style> is C<cs::Simple>.
=item listProfile HASH
Assigns hash of properties, passed to the listbox during the creation.
Assigns a hash of properties passed to the list box during the creation.
Create-only property.
=item listDelegations ARRAY
Assigns a selection listbox list of delegated notifications.
Assigns the list of delegated notifications to the list box.
Create-only property.
=item literal BOOLEAN
Selects whether the combo box user input routine assume that
the listbox contains literal strings, that can be fetched via
C<get_item_text> ( see L<Prima::Lists> ). As an example when
this property is set to 0 is C<Prima::ColorComboBox> from L<Prima::ComboBox> package.
Selects whether the combo box user input routine should assume that the list box
contains literal strings, that can be fetched via C<get_item_text> ( see
L<Prima::Lists> ). An example when this property is set to 0 is
C<Prima::ColorComboBox> from the L<Prima::ComboBox> package.
Default value: 1
=item style INTEGER
Selected one of three styles:
Selects one of three styles of the combo box:
=over
=item cs::Simple
The listbox is always visible, and the drop-down button is not.
The list box is always visible, but the drop-down button is not.
=item cs::DropDown
The listbox is not visible, but the drop-down button is. When the
use presses the drop-down button, the listbox is shown; when the list-box
The list box is not visible, but the drop-down button is. When the
user presses the drop-down button, the list box is shown; when the list-box
is defocused, it gets hidden.
=item cs::DropDownList
Same as C<cs::DropDown>, but the user is restricted in the selection:
the input line can only accept user input that is contained in listbox.
If L<literal> set to 1, the auto completion feature is provided.
Same as C<cs::DropDown> but the user is restricted in selection:
the input line can only accept user input that is present in the list box.
If L<literal> is set to 1, the auto-completion feature is provided.
=back
=item text STRING
Mapped onto the edit widget's C<text> property.
Alias of the input line's C<text> property.
=back
Expand All @@ -928,14 +928,13 @@ Mapped onto the edit widget's C<text> property.
=item Change
Triggered with ComboBox value is changed.
Triggered the value is changed.
=item List events
ComboBox forwards C<SelectItem> and C<DrawItem> events from the list box, and
these are executed in the List's context (therefore $self there is not
ComboBox, but the ComboBox->List). If you use C<SelectItem> you probably need
C<Change> instead.
ComboBox, but the ComboBox->List).
See more in L<Prima::Lists>.
Expand Down
Loading

0 comments on commit 63dc672

Please sign in to comment.