prima::tie(3) [debian man page]

Prima::Tie(3)						User Contributed Perl Documentation					     Prima::Tie(3)

NAME

       Prima::Tie - tie widget properties to scalars or arrays.

DESCRIPTION

       Prima::Tie contains two abstract classes, "Prima::Tie::Array" and "Prima::Tie::Scalar", which tie an array or a scalar to a widget's
       arbitrary array or scalar property.  Also, it contains classes "Prima::Tie::items", "Prima::Tie::text", and "Prima::Tie::value", which tie
       a variable to a widget's items, text, and value property respectively.

SYNOPSIS

	       use Prima::Tie;

	       tie @items, 'Prima::Tie::items', $widget;

	       tie @some_property, 'Prima::Tie::Array', $widget, 'some_property';

	       tie $text, 'Prima::Tie::text', $widget;

	       tie $some_property, 'Prima::Tie::Scalar', $widget, 'some_property';

USAGE

       These classes provide immediate access to a widget's array and scalar property, in particular to popular properties as items and text. It
       is considerably simpler to say

	       splice(@items,3,1,'new item');

       than to say

	       my @i = @{$widget->items};
	       splice(@i,3,1,'new item');
	       $widget->items(@i);

       You can work directly with the text or items rather than at a remove.  Furthermore, if the only reason you keep an object around after
       creation is to access its text or items, you no no longer need to do so:

	       tie @some_array, 'Prima::Tie::items', Prima::ListBox->create(@args);

       As opposed to:

	       my $widget = Prima::ListBox->create(@args);
	       tie @some_array, 'Prima::Tie::items', $widget;

       "Prima::Tie::items" requires "::items" property to be available on the widget.  Also, it takes advantage of additional "get_items",
       "add_items", and the like if available.

   Prima::Tie::items
       The class is applicable to "Prima::ListViewer", "Prima::ListBox", "Prima::Header", and their descendants, and in limited fashion to
       "Prima::OutlineViewer" and its descendants "Prima::StringOutline" and "Prima::Outline".

   Prima::Tie::text
       The class is applicable to any widget.

   Prima::Tie::value
       The class is applicable to "Prima::GroupBox", "Prima::ColorDialog", "Prima::SpinEdit", "Prima::Gauge", "Prima::Slider",
       "Prima::CircularSlider", and "Prima::ScrollBar".

COPYRIGHT

       Copyright 2004 Teo Sankaro

       You may redistribute and/or modify this module under the same terms as Perl itself.  (Although a credit would be nice.)

AUTHORS

       Teo Sankaro, <teo_sankaro@hotmail.com>.	Dmitry Karasik, <dmitry@karasik.eu.org>.

perl v5.14.2							    2009-02-24							     Prima::Tie(3)

Prima::EditDialog(3)					User Contributed Perl Documentation				      Prima::EditDialog(3)

NAME

       Prima::FindDialog, Prima::ReplaceDialog - standard interface dialogs to find and replace options selection.

SYNOPSIS

	       use Prima::StdDlg;

	       my $dlg = Prima::FindDialog-> create( findStyle => 0);
	       my $res = $dlg-> execute;
	       if ( $res == mb::Ok) {
		       print $dlg-> findText, " is to be found
";
	       } elsif ( $res == mb::ChangeAll) {
		       print "all occurences of ", $dlg-> findText,
			       " is to be replaced by ", $dlg-> replaceText;
	       }

       The "mb::ChangeAll" constant, one of possible results of "execute" method, is defined in Prima::StdDlg module. Therefore it is recommended
       to include this module instead.

DESCRIPTION

       The module provides two classes - Prima::FindDialog and Prima::ReplaceDialog; Prima::ReplaceDialog is exactly same as Prima::FindDialog
       except that its default findStyle property value is set to 0. One can use a dialog-caching technique, arbitrating between findStyle value 0
       and 1, and use only one instance of Prima::FindDialog.

       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 "Prima::Edit" class is found in "find" in Prima::Edit, and the another part - in
       examples/editor.pl example program. Prima::HelpWindow also uses the module, and realizes its own searching algorithm.

API

   Properties
       All the properties select the user-assigned values, except findStyle.

       findText STRING
	   Selects the text string to be found.

	   Default value: ''

       findStyle BOOLEAN
	   If 1, the dialog provides only 'find text' interface. If 0, the dialog provides also 'replace text' interface.

	   Default value: 1 for "Prima::FindDialog", 0 for "Prima::ReplaceDialog".

       options INTEGER
	   Combination of "fdo::" constants. For the detailed description see "find" in Prima::Edit.

		   fdo::MatchCase
		   fdo::WordsOnly
		   fdo::RegularExpression
		   fdo::BackwardSearch
		   fdo::ReplacePrompt

	   Default value: 0

       replaceText STRING
	   Selects the text string that is to replace the found text.

	   Default value: ''

       scope
	   One of "fds::" 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.

		   fds::Cursor
		   fds::Top
		   fds::Bottom

	   Default value: "fds::Cursor"

AUTHOR

       Dmitry Karasik, <dmitry@karasik.eu.org>.

SEE ALSO

       Prima, Prima::Window, Prima::StdDlg, Prima::Edit, Prima::HelpWindow, examples/editor.pl

perl v5.14.2							    2009-02-24						      Prima::EditDialog(3)