NAME

Rui - Perl Remote User Interface


SYNOPSIS

  use Rui; # this script uses the Rui framework


DESCRIPTION

Perl Rui is a Perl UI framework for remote user interfaces. Rui distributes the UI at the widget level. If you were sniffing the line you might hear this boot message:

  Window.create(W1);
  Label.create(W1,E1,-1);
  Label.value(W1,E1,Hello World);

Perl Rui is part of a set of tools for presentation clients and servers:

  Server             Network      Client
  ------             -------      ------
  * Perl Rui     ]\             /[ * RuiIE6
  * SWTRui      | \___________/ | * RuiNS6
  * ...         | /    Rui    \ | * ...
                ]/   protocol  \[

This module must be used in all Perl Rui scripts. Scripts must be run from somewhere within the directory of the Perl Rui project you are using. This project directory must be under the Perl Rui projects home directory. E.g. assuming we are now using the myproject project:

  Rui/              Rui home
     Perl/          $Rui::PROJECTS_HOME Perl Rui projects home, set on install
        base/       Perl Rui base project
        myproject/  $Rui::PROJECT_HOME current project

This module defines $Rui::$PROJECT_BASE_NAME, $Rui::PROJECT_NAME, $Rui::PROJECTS_HOME, and $Rui::PROJECT_HOME. It also adds the perllib/ under the Perl Rui base project to @INC. If the current project is not base, then the perllib/ under the current project is added to @INC as well.

$Rui::PROJECTS_HOME is found by climbing up from the working directory of the script, looking for a file called .Perl Rui_projects_home or Perl Rui_projects_home (easier to create on MSWin32). The directory of the file is set as the Perl Rui projects home.

After using this module you can use any Perl Rui class and classes from the current project.


REQUIRES


INSTALLATION

To install Perl Rui follow these steps: