ZConf::template::GUI - ZConf::template::GUI documentation


ZConf-DevTemplate documentation  | view source Contained in the ZConf-DevTemplate distribution.

Index


NAME

Top

ZConf::template::GUI -

VERSION

Top

Version 0.0.0

SYNOPSIS

Top

Quick summary of what the module does.

Perhaps a little code snippet.

    use ZConf::template::GUI;

    my $foogui = ZConf::template::GUI->new();
    ...

METHODS

Top

new

args hash

obj

This is object returned by %%%PARENT%%%.

    my $foogui=ZConf::template::GUI->new({obj=>$obj});
    if($foogui->{error}){
         print "Error!\n";
    }

app

Runs some application.

    $foogui->app;
    if($foogui->{error}){
        warn('error '.$foogui->error.': '.$foogui->errorString);
    }

hasApp

If this returns true, it means it has a application.

    my $hasApp=$foogui->hasApp;
    if($foogui->{error}){
        warn('error '.$foogui->error.': '.$foogui->errorString);
    }else{
        if($hasApp){
            print "Yes\n";
        }
    }

DIALOG/WINDOW METHODS

Top

dialogs

This returns a array of available dialogs.

    my @dialogs=$foogui->dialogs;
    if($foogui->{error}){
        warn('error '.$foogui->error.': '.$foogui->errorString);
    }

hasDialog

This checks if the loaded backend supports a specific dialog.

    my $supported=$foogui->hasDialog($dialogName);
    if($foogui->error){
        warn('error '.$foogui->error.': '.$foogui->errorString);
    }
    if(!supported){
        warn($dialogName.' is not supported');
    }

hasWindow

This checks if the loaded backend supports a specific window.

    my $supported=$foogui->hasWindow($windowName);
    if($foogui->error){
        warn('error '.$foogui->error.': '.$foogui->errorString);
    }
    if(!supported){
        warn($windowName.' is not supported');
    }

windows

This returns a array of available dialogs.

    my @windows=$foogui->windows;
    if($foogui->{error}){
        warn('error '.$foogui->error.': '.$foogui->errorString);
    }

ERROR RELATED METHODS

Top

error

This returns the current error code if one is set. If undef/evaulates as false then no error is present. Other wise one is.

    if($foogui->error){
        warn('error '.$foogui->error.': '.$foogui->errorString);
    }

errorString

This returns the current error string. A return of "" means no error is present.

    my $errorString=$foogui->errorString;

errorblank

This blanks the error storage and is only meant for internal usage.

It does the following.

    $foogui->{error}=undef;
    $foogui->{errorString}="";

ERROR CODES

Top

1

Failed to initiate %%%PARENT%%%.

2

Failed to initiate ZConf::GUI.

3

Failed to get the preferred.

4

Failed to initiate the backend.

5

Backend errored.

6

No backend found via ZConf::GUI->which.

7

No dialog specified.

AUTHOR

Top

%%%AUTHOR%%%, <%%%EMAIL%%%>

BUGS

Top

Please report any bugs or feature requests to bug-zconf-devtemplate at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=ZConf-template. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

Top

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

    perldoc ZConf::template::GUI




You can also look for information at:

* RT: CPAN's request tracker

http://rt.cpan.org/NoAuth/Bugs.html?Dist=%%%PARENT%%%

* AnnoCPAN: Annotated CPAN documentation

http://annocpan.org/dist/%%%PARENT%%%

* CPAN Ratings

http://cpanratings.perl.org/d/%%%PARENT%%%

* Search CPAN

http://search.cpan.org/dist/%%%PARENT%%%/

ACKNOWLEDGEMENTS

Top

COPYRIGHT & LICENSE

Top


ZConf-DevTemplate documentation  | view source Contained in the ZConf-DevTemplate distribution.