Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

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

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)

Check Out this Related Man Page

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

NAME

       Prima::KeySelector - key combination widget and routines

DESCRIPTION

       The module provides a standard widget for selecting a user-defined key combination. The widget class allows import, export, and
       modification of key combinations.

       The module provides a set of routines, useful for conversion of a key combination between representations.

SYNOPSIS

	       my $ks = Prima::KeySelector-> create( );
	       $ks-> key( km::Alt | ord('X'));
	       print Prima::KeySelector::describe( $ks-> key );

API

   Properties
       key INTEGER
	   Selects a key combination in integer format. The format is described in "Hot key" in Prima::Menu, and is a combination of "km::XXX" key
	   modifiers and either a "kb::XXX" virtual key, or a character code value.

	   The property allows almost, but not all possible combinations of key constants. Only "km::Ctrl", "km::Alt", and "km::Shift" modifiers
	   are allowed.

   Methods
       All methods here can ( and must ) be called without the object syntax; - the first parameter must not be neither package nor widget.

       describe KEY
	   Accepts KEY in integer format, and returns string description of the key combination in human readable format. Useful for supplying an
	   accelerator text to a menu.

		   print describe( km::Shift|km::Ctrl|km::F10);
		   Ctrl+Shift+F10

       export KEY
	   Accepts KEY in integer format, and returns string with a perl-evaluable expression, which after evaluation resolves to the original KEY
	   value. Useful for storing a key into text config files, where value must be both human readable and easily passed to a program.

		   print export( km::Shift|km::Ctrl|km::F10);
		   km::Shift|km::Ctrl|km::F10

       shortcut KEY
	   Converts KEY from integer format to a string, acceptable by "Prima::AbstractMenu" input methods.

		   print shortcut( km::Ctrl|ord('X'));
		   ^X

       translate_codes KEY, [ USE_CTRL = 0 ]
	   Converts KEY in integer format to three integers in the format accepted by "KeyDown" in Prima::Widget event: code, key, and modifier.
	   USE_CTRL is only relevant when KEY first byte ( "KEY & 0xFF" ) is between 1 and 26, what means that the key is a combination of an
	   alpha key with the control key.  If USE_CTRL is 1, code result is unaltered, and is in range 1 - 26.  Otherwise, code result is
	   converted to the character code ( 1 to ord('A'), 2 to ord('B') etc ).

AUTHOR

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

SEE ALSO

       Prima, Prima::Widget, Prima::Menu.

perl v5.14.2							    2009-02-24						     Prima::KeySelector(3)
Man Page