- new ( OPTIONS )
-
Create a new Curses::UI instance. See the OPTIONS section above
to find out what options can be used.
- leave_curses ( )
-
Temporarily leaves curses mode and recovers normal terminal
mode.
- reset_curses ( )
-
Return to curses mode after leave_curses().
- add ( ID, CLASS, OPTIONS )
-
The add method of Curses::UI is almost the same as the add
method of Curses::UI::Container. The difference is that Curses::UI
will only accept classes that are (descendants) of the
Curses::UI::Window class. For the rest of the information
see Curses::UI::Container.
- mainloop ( )
-
Starts a Tk like main loop that will handle input and events.
- MainLoop ( )
-
Same as mainloop, for Tk compatibility.
- schedule_event ( CODE )
-
The schedule_event method adds a method to the mainloop. This
method is executed one time after the input handler has run and
deleted from the mainloop afterwards.
- add_callback ( ID, CODE)
-
This method lets you add a callback into the mainloop permanently.
The code is executed after the input handler has run.
- delete_callback ( ID )
-
This method deletes the CODE specified by ID from the mainloop.
- usemodule ( CLASSNAME )
-
Loads the with CLASSNAME given module.
- userdata ( [ SCALAR ] )
-
This method will return the user internal data stored in the UI object.
If a SCALAR parameter is specified it will also set the current user
data to it.
- layout ( )
-
The layout method of Curses::UI will try to find out the size of the
screen. After that it will call the layout routine of every
contained object. So running layout on a Curses::UI object will
effectively layout the complete application. Normally you will not
have to call this method directly.
- compat ( [BOOLEAN] )
-
The -compat option will be set to the BOOLEAN value, unless
BOOLEAN is omitted. The method returns the current value
for -compat.
- clear_on_exit ( [BOOLEAN] )
-
The -clear_on_exit option will be set to the BOOLEAN value, unless
BOOLEAN is omitted. The method returns the current value
for -clear_on_exit.
- dialog ( MESSAGE or OPTIONS )
-
Use the dialog method to show a dialog window. If you only
provide a single argument, this argument will be used as the
message to show. Example:
$cui->dialog("Hello, world!");
If you want to have some more control over the dialog window, you
will have to provide more arguments (for an explanation of the
arguments that can be used, see
Curses::UI::Dialog::Basic.
Example:
my $yes = $cui->dialog(
-message => "Hello, world?",
-buttons => ['< Yes >','< No >'],
-values => [1,0],
-title => 'Question',
);
if ($yes) {
# whatever
}
- error ( MESSAGE or OPTIONS )
-
The error method will create an error dialog. This is
basically a Curses::UI::Dialog::Basic, but it has an ASCII-art
exclamation sign drawn left to the message. For the rest
it's just like dialog. Example:
$cui->error("It's the end of the\n"
."world as we know it!");
- filebrowser ( OPTIONS )
-
The filebrowser method will create a file browser
dialog. For an explanation of the arguments that can be
used, see Curses::UI::Dialog::Filebrowser.
Example:
my $file = $cui->filebrowser(
-path => "/tmp",
-show_hidden => 1,
);
# Filebrowser will return undef
# if no file was selected.
if (defined $file) {
unless (open F, ">$file") {
print F "Hello, world!\n";
close F;
} else {
$cui->error("Error on writing to "
."\"$file\":\n$!");
}
}
- loadfilebrowser( OPTIONS )
-
- savefilebrowser( OPTIONS )
-
These two methods will create file browser dialogs as well.
The difference is that these will have the dialogs set up
correctly for loading and saving files. Moreover, the save
dialog will check if the selected file exists or not. If it
does exist, it will show an overwrite confirmation to check
if the user really wants to overwrite the selected file.
- status ( MESSAGE )
-
- nostatus ( )
-
Using these methods it's easy to provide status information for
the user of your program. The status dialog is a dialog with
only a label on it. The status dialog doesn't really get the
focus. It's only used to display some information. If you need
more than one status, you can call status subsequently.
Any existing status dialog will be cleaned up and a new one
will be created.
If you are finished, you can delete the status dialog by calling
the nostatus method. Example:
$cui->status("Saying hello to the world...");
# code for saying "Hello, world!"
$cui->status("Saying goodbye to the world...");
# code for saying "Goodbye, world!"
$cui->nostatus;
- progress ( OPTIONS )
-
- setprogress ( POSITION, MESSAGE )
-
- noprogress ( )
-
Using these methods it's easy to provide progress information
to the user. The progress dialog is a dialog with an optional
label on it and a progress bar. Similar to the status dialog,
this dialog does not get the focus.
Using the progress method, a new progress dialog can be
created (see also
Curses::IU::Dialog::Progress).
This method takes the same arguments as the Curses::IU::Dialog::Progress
class.
After that the progress can be set using setprogress. This
method takes one or two arguments. The first argument is the current
position of the progressbar. The second argument is the message
to show in the label. If one of these arguments is undefined,
the current value will be kept.
If you are finished, you can delete the progress dialog by calling
the noprogress method.
Example:
$cui->progress(
-max => 10,
-message => "Counting 10 seconds...",
);
for my $second (0..10) {
$cui->setprogress($second)
sleep 1;
}
$cui->noprogress;
- color ( )
-
Returns the currently used Curses::UI::Color object
- set_color ( OBJECT )
-
Replaces the currently used Color object with an other. This
can be used to fast change all colors in a Curses::UI application.
This package is free software and is provided ``as is'' without express
or implied warranty. It may be used, redistributed and/or modified
under the same terms as perl itself.
