ManaTools::MainDisplay

Section: User Contributed Perl Documentation (3)
Updated: 2017-07-06
Page Index
 

NAME

ManaTools::MainDisplay - class for ManaTools main window  

SYNOPSIS

    $mainDisplay = new ManaTools::MainDisplay();
    $mainDisplay->start();
    $mainDisplay->cleanup();

 

METHODS

 

DESCRIPTION

    ManaTools::MainDisplay implements the main window panel adding buttons
    reading the configuration for every categories and modules

 

SUPPORT

    You can find documentation for this module with the perldoc command:

    perldoc ManaTools::MainDisplay

 

AUTHOR

    Steven Tucker

 

COPYRIGHT and LICENSE

    Copyright (C) 2012-2016, Angelo Naselli.
    Copyright (C) 2012, Steven Tucker.

    ManaTools is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 2 of the License, or
    (at your option) any later version.

    ManaTools is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with ManaTools.  If not, see <http://www.gnu.org/licenses/>.

 

METHODS

 

new

INPUT

    hash ref containing
        configDir: configuration files directory
        name:    application name, logging identity,
                 configuration subdirectory

other attributes

    title:        window title got from configuration file,
                  default is name.
    categories:   ArrayRef[ManaTools::Category]
    settings:     HashRef containing settings file content
    currCategory: Selected category
    mainWin:      Main Dialog window
    factory:      yui::YUI::widgetFactory
    menus:        HashRef containing menu items
    leftPane:     left panel layout
    rightPane:    right panel layout
  rightPaneFrame: right frame (needed for category title)
    replacePoint: replace point where to set new layout on
                  category selection
  selectedModule: module to be returned when selected

DESCRIPTION

    This method instanziates the MainWindo object, and setups
    the startup GUI.

 

configName

INPUT

    $self: this object

OUTPUT

    name: application name

DESCRIPTION

    Returns the application name as configuration subdirectory.
    This method is required by ConfifDirRole

 

start

    contains the main loop of the application
    where we can check for events

 

cleanup

INPUT

    $self:     this object

DESCRIPTION

    This method cleanup data for a further start.

 

_setupGui

INPUT

    $self:     this object

DESCRIPTION

    This method load configuration and build the GUI layout.


 

Index

NAME
SYNOPSIS
METHODS
DESCRIPTION
SUPPORT
AUTHOR
COPYRIGHT and LICENSE
METHODS
new
configName
start
cleanup
_setupGui