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

pod::Prima::Timer(3)					User Contributed Perl Documentation				      pod::Prima::Timer(3)

NAME

       Prima::Timer - programmable periodical events

SYNOPSIS

	   my $timer = Prima::Timer-> create(
	       timeout => 1000, # milliseconds
	       onTick  => sub {
		  print "tick!
";
	       },
	   );

	   $timer-> start;

DESCRIPTION

       Prima::Timer arranges periodical notifications to be delivered in certain time intervals.  The notifications are triggered by the system,
       and are seen as "Tick" events. There can be many active Timer objects at one time, spawning events simultaneously.

USAGE

       Prima::Timer is a descendant of Prima::Component.  Objects of Prima::Timer class are created in standard fashion:

	 my $t = Prima::Timer-> create(
	    timeout => 1000,
	    onTick  => sub { print "tick
"; },
	 );
	 $t-> start;

       If no `owner` is given, $::application is assumed.

       Timer objects are created in inactive state; no events are spawned. To start spawning events, <start()> method must be explicitly called.
       Time interval value is assigned using the <::timeout> property in milliseconds.

       When the system generates timer event, no callback is called immediately, - an event is pushed into stack instead, to be delivered during
       next event loop.  Therefore, timeout value is not held accurately, and events may take longer time to pass. More accurate timing scheme, as
       well as timing with precision less than a millisecond, is not supported by the toolkit.

API

   Properties
       timeout MILLISECONDS
	   Manages time interval between "Tick" events.  In set-mode call, if the timer is in active state ( see "get_active()", the new timeout
	   value is applied immediately.

   Methods
       get_active
	   Returns a boolean flag, whether object is in active state or not. In the active state "Tick" events are spawned after "::timeout" time
	   intervals.

       get_handle
	   Returns a system-dependent handle of object

       start
	   Sets object in active state. If succeed, or if the object is already in active state, returns 1. If the system was unable to create a
	   system timer instance, 0 is returned.

       stop
	   Sets object in inactive state.

   Events
       Tick
	   A system generated event, spawned every "::timeout" milliseconds if object is in active state.

AUTHOR

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

SEE ALSO

       Prima, Prima::Object

perl v5.14.2							    2009-02-24						      pod::Prima::Timer(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)