Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
Toader::Gallery(3)    User Contributed Perl Documentation   Toader::Gallery(3)

NAME
       Toader::Gallery - Handle	image galleries.

VERSION
       Version 0.1.0

METHODS
   new
       This initiates the object.

       There is	one  argument is required and this is a	Toader object.

	   my $foo = Toader::AutoDoc->new($toader);
	   if (	$foo->error ){
	       warn('error:'.$foo->error.': '.$foo->errorString);
	   }

   delConfig
       This removes a gallery config for a directory.

   dirGet
       This gets Toader	directory this entry is	associated with.

       This will only error if a permanent error is set.

       This will return	undef if no directory has been set.

	   my $dir=$foo->dirGet;
	   if($foo->error){
	       warn('Error:'.$foo->error.': '.$foo->errorString);
	   }

   dirSet
       This sets Toader	directory this entry is	associated with.

       One argument is taken and it is the Toader directory to set it to.

	   my $dir=$foo->dirSet($toaderDirectory);
	   if($foo->error){
	       warn('Error:'.$foo->error.': '.$foo->errorString);
	   }

   init
       This is initializes the config for a directory. This is automatically
       called if it has	not been done so for a directory.

   outputPathGet
       This returns the	output path.

	   my $outputPath=$foo->outputPathGet;
	   if (	$foo->error ){
	       warn( 'error:'.$foo->error.': '.$foo->errorString );
	   }

   outputPathSet
       This returns the	output path.

	   $foo->outputPathSet(	$outputPath );
	   if (	$foo->error ){
	       warn( 'error:'.$foo->error.': '.$foo->errorString );
	   }

   outputURLget
       This returns the	output path.

	   my $outputURL=$foo->outputURLget;
	   if (	$foo->error ){
	       warn( 'error:'.$foo->error.': '.$foo->errorString );
	   }

   outputURLset
       This sets the output URL.

	   my $outputURL=$foo->outputURLget;
	   if (	$foo->error ){
	       warn( 'error:'.$foo->error.': '.$foo->errorString );
	   }

   srcPathGet
       This returns the	source path.

	   my $srcPath=$foo->srcPath;
	   if (	$foo->error ){
	       warn('error:'.$foo->error.': '.$foo->errorString);
	   }

   srcPathSet
       This sets the that to search for	images.

       One argument is required	and it is a path.

	   $foo->srcPathSet( $srcPath );
	   if (	$foo->error ){
	       warn( 'error:'.$foo->error.': '.$foo->errorString );
	   }

   srcURLget
       This gets the URL to use	for the	images.

	   my $srcURLget=$foo->srcURLget;
	   if (	$foo->error ){
	       warn('error:'.$foo->error.': '.$foo->errorString);
	   }

   srcURLset
       This sets the URL that is used for linking to the source	images.

	   $foo->srcURLset( $url );
	   if (	$foo->error ){
	       warn( 'error:'.$foo->error.': '.$foo->errorString );
	   }

   renderUpdateDetailsGet
       Returns if upon rendering it should update image	details	or not.

       The return value	is a Perl boolean.

	   my $update=$foo->renderUpdateDetailsGet;
	   if (	$foo->error ){
	       warn('error:'.$foo->error.': '.$foo->errorString);
	   }

   renderUpdateDetailsSet
       This sets wether	or note	Toader::Render::Gallery->render	should update
       the details or not.

       This takes a Perl boolean.

	   $foo->renderUpdateDetailsGet( $update );
	   if (	$foo->error ){
	       warn('error:'.$foo->error.': '.$foo->errorString);
	   }

   renderUpdateIndexesGet
       Returns if upon rendering it should update the indexes or not.

       The return value	is a Perl boolean.

	   my $update=$foo->renderUpdateIndexesGet;
	   if (	$foo->error ){
	       warn('error:'.$foo->error.': '.$foo->errorString);
	   }

   renderUpdateIndexesSet
       This sets wether	or note	Toader::Render::Gallery->render	should update
       the indexes or not.

       This takes a Perl boolean.

	   $foo->renderUpdateIndexesGet( $update );
	   if (	$foo->error ){
	       warn('error:'.$foo->error.': '.$foo->errorString);
	   }

   renderUpdateScaledGet
       Returns if upon rendering it should update the scaled images or not.

       The return value	is a Perl boolean.

	   my $update=$foo->renderUpdateIndexesGet;
	   if (	$foo->error ){
	       warn('error:'.$foo->error.': '.$foo->errorString);
	   }

   renderUpdateScaledSet
       This sets wether	or note	Toader::Render::Gallery->render	should update
       the scaled images or not.

       This takes a Perl boolean.

	   $foo->renderUpdateIndexesGet( $update );
	   if (	$foo->error ){
	       warn('error:'.$foo->error.': '.$foo->errorString);
	   }

   resolutionSmallGet
       Returns the small resolution.

	   my $smallRes=$foo->resolutionSmallGet;
	   if (	$foo->error ){
	       warn('error:'.$foo->error.': '.$foo->errorString);
	   }

   resolutionSmallSet
       Sets the	small resolution.

       One argument is taken and that is the maximum resolution	for a image.
       If not specified, it resets it to 200.

	   my $smallRes=$foo->resolutionSmallSet( $resolution );
	   if (	$foo->error ){
	       warn('error:'.$foo->error.': '.$foo->errorString);
	   }

   resolutionLargeGet
       Returns the larg	resolution.

	   my $largeRes=$foo->resolutionLargeGet;
	   if (	$foo->error ){
	       warn('error:'.$foo->error.': '.$foo->errorString);
	   }

   resolutionLargeSet
       Returns the larg	resolution.

       One argument is taken is	the maximum resolution to use.	If not
       specified, it resets it to the default, 1024.

	   $foo->resolutionLargeSet( $res );
	   if (	$foo->error ){
	       warn('error:'.$foo->error.': '.$foo->errorString);
	   }

   usable
       This checks if the this object is usable	for rendering or not.

       It does not check if the	directories exist, other than the settings are
       specified.

	   if (	! $foo->usable ){
	       print "This is not a renderable object currently... something is	missing...\n";
	   }

   writeConfig
       This writes the config out.

REQUIRED RENDERING METHODS
       The ones	listed below are useless and are just included for
       compatibility reasons.

	   filesDir
	   renderDir
	   toDir

   filesDir
       This returns the	file directory for the object.

       This is not a full path,	but a partial path that	should be appended the
       directory current directory being outputted to.

       This returns '' as it is	not used by this module. As for	rendering,
       fullURL is set for Toader::Render::General.

   locationID
       This returns the	location ID.

       This one	requires the object to be initialized.

   renderDir
       This is the directory that it will be rendered to.

       The base	directory that will be used for	rendering.

       This returns '' as it is	not used by this module. As for	rendering,
       fullURL is set for Toader::Render::General.

   renderUsing
       This returns the	module to use for rendering.

	   my $module=$foo->renderUsing;

   toaderRenderable
       This method returns true	and marks it as	being Toader renderable.

   toDir
       This returns the	directory that will return the directory that contains
       where this object should	be rendered to.

       This is not a full path,	but a partial path that	should be appended the
       directory current directory being outputted to.

       This returns '' as it is	not used by this module. As for	rendering,
       fullURL is set for Toader::Render::General.

ERROR CODES
   1, noDirSpecified
       No directory specified.

   2, notAtoaderDir
       The directory is	not a Toader directory.

   3, readConfigFailed
       Failed to read the gallery config.

   4, noConfig
       No config for this directory.

   5, nonNumericResolution
       The specified resolution	is non-numeric.

   6, noSrcPath
       No source path specified.

   7, noSrcURL
       No source URL specified.

   8, noOutputPath
       No output path specified.

   9, noOutputURL
       No output URL specified.

   10, dirAlreadyInit
       The directory has already been initialized.

   11, pathHelperErrored
       Failed to initialize Toader::pathHelper.

   12, notAtoaderObj
       Not a Toader object.

   13, getVCSerrored
       Toader->getVCS errored.

   14, VCSusableErrored
       Toader::VCS->usable errored.

   15, underVCSerrored
       Toader::VCS->underVCS errored.

   16, VCSaddErrored
       Toader::VCS->add	errored.

   17, VCSdeleteErrored
       Toader::VCS->delete errored.

   18, noToaderObj
       Nothing passed for a Toader object.

AUTHOR
       Zane C. Bowers-Hadley, "<vvelox at vvelox.net>"

BUGS
       Please report any bugs or feature requests to "bug-toader at
       rt.cpan.org", or	through	the web	interface at
       <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Toader>.	 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 Toader::AutoDoc

       You can also look for information at:

       o   RT: CPAN's request tracker

	   <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Toader>

       o   AnnoCPAN: Annotated CPAN documentation

	   <http://annocpan.org/dist/Toader>

       o   CPAN	Ratings

	   <http://cpanratings.perl.org/d/Toader>

       o   Search CPAN

	   <http://search.cpan.org/dist/Toader/>

ACKNOWLEDGEMENTS
LICENSE	AND COPYRIGHT
       Copyright 2011 Zane C. Bowers-Hadley.

       This program is free software; you can redistribute it and/or modify it
       under the terms of either: the GNU General Public License as published
       by the Free Software Foundation;	or the Artistic	License.

       See http://dev.perl.org/licenses/ for more information.

perl v5.32.0			  2013-04-27		    Toader::Gallery(3)
NAME | VERSION | METHODS | REQUIRED RENDERING METHODS | ERROR CODES | AUTHOR | BUGS | SUPPORT | ACKNOWLEDGEMENTS | LICENSE AND COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Toader::Gallery&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help