Zane C. Bowers-Hadley > PerlFM > PerlFM

Download:
PerlFM-0.2.0.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.2.0   Source  

NAME ^

PerlFM - A Perl based file manager.

VERSION ^

Version 0.2.0

SYNOPSIS ^

    use PerlFM;
    use Gtk2;
    
    my $pfm = PerlFM->new();
    
    Gtk2->init;
    
    my $window = Gtk2::Window->new();
    
    my %gui=$pfm->filemanager;
    
    $window->add($gui->{VB});
    
    $window->show;
    
    Gtk2-main;

METHODES ^

new

Initiates the new function.

addBM

This is the call back that is called when the addBM button is clicked.

app

This invokes it as application.

Upon the window being destroyed, it will exit.

This method does not return. Upon being called it creates a window and when that window is destroyed, it exits.

args hash

path

This is the path to start in.

hidden

If this is set to true, hidden files will be shown.

    $args{path}='/tmp';
    $args{hidden}=0;
    $pfm->app(\%args);

askYN

This is used in a few places to present a yes/no dialog.

checkForUpdate

This checks for any updates to a directory.

One arguement is accepted and it is a

    $pfm->checkForUpdate($guiID);

chmod

This is the call back that is called when a chmod key/button is pressed.

chown

This is the call back that is called when a mkdir key/button is pressed.

datahash

This builds the data hash for the current directory. This is primarily for internal use.

delete

This is a call back the handles deleting files.

deleteBM

This is the call back used when the currently seleced book mark is being deleted.

editBM

This is the call back used for editing the current bookmark.

filemanager

This returns a hash that contains the various elements.

args hash

path

This is the path to start in.

hidden

If this is set to true, hidden files will be shown.

    $args{path}='/tmp';
    $args{hidden}=0;
    
    my %gui=$pfm->filemanager(\%args);
    
    #get it again after it has been created
    my $guiID=$gui{id};
    %gui=%{$pfm->{gui}{$guID}};

getAction

This fetches the default action.

    my $action=$self->getAction;

mkdir

This is the call back that is called when a mkdir key/button is pressed.

runViaNew

This is the call back that is called when a entry is asked to be run via new a new action.

setAction

This sets the default action to use with the ZConf::Runner.

One arguement is taken and that is the name of the action.

    $pfm-setAction($action);

setActionCB

This is the call back used by the set default action button.

update

This is the is used by callbacks for updating.

    $pfm->update($gui{id}, $self);

updateBM

This is the method that is used for updating the bookmark selection.

It is called automatically as needed.

updateRmenu

This updates the r menu and used by various callbacks.

window

This returns a hash containing the various widgets.

args hash

path

This is the path to start in.

hidden

If this is set to true, hidden files will be shown.

    $args{path}='/tmp';
    $args{hidden}=0;
    my %winhash=$pfm->window(\%args);
    $winhash{window}->show;
    Gtk2->init;

errorblank

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

It does the following.

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

AUTHOR ^

Zane C. Bowers, <vvelox at vvelox.net>

BUGS ^

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

SUPPORT ^

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

    perldoc PerlFM

You can also look for information at:

ACKNOWLEDGEMENTS ^

COPYRIGHT & LICENSE ^

Copyright 2009 Zane C. Bowers, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: