Visio::Page - Perl extension for visio shapes


Visio documentation Contained in the Visio distribution.

Index


Code Index:

NAME

Top

Visio::Page - Perl extension for visio shapes

SYNOPSIS

Top

 to be used with Visio module


Visio documentation Contained in the Visio distribution.

package Visio::Page;

#PLEASE SEE MSPATENTLICENSE
# "This product may incorporate intellectual property owned by 
# Microsoft Corporation. The terms and conditions upon which Microsoft 
# is licensing such intellectual property may be found at 
# http://msdn.microsoft.com/library/en-us/odcXMLRef/html/odcXMLRefLegalNotice.asp"

# Copyright 2005 Aamer Akhter. All rights reserved.

# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:

# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.

# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.

# THIS SOFTWARE IS PROVIDED BY THE LICENSOR(S) ``AS IS'' AND ANY EXPRESS
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE LICENSOR(S) OR OTHER CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
# BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
# IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

# The views and conclusions contained in the software and documentation
# are those of the authors and should not be interpreted as representing
# official policies, either expressed or implied, of the Licensor(s).

# The software may be subject to additional license restrictions
# provided by the Licensor(s).



use 5.008;
use strict;
use warnings;
use Log::Log4perl  qw(get_logger);
use XML::LibXML;
use Carp;
use Data::Dumper;
use vars qw($VERSION);

use Visio::PageSheet;
use Visio::Shape;


$VERSION = sprintf "%d.%03d", q$Revision: 1.8 $ =~ /: (\d+)\.(\d+)/;

my $log = get_logger('visio.page');

# Preloaded methods go here.

sub new {
    my $class = shift;
    my $pagesN = shift;
    my $id = shift;
    my $self = {};
    $self->{pagesN} = $pagesN;
    $self->{xmldoc} = $pagesN->ownerDocument;
    $self->{xmlroot} = $self->{xmldoc}->documentElement;
    $self->{pageid} = $id;
    bless($self,$class);
    $self->{pageN} = $self->{xmldoc}->createElement('Page');
    $self->{pagesN}->appendChild($self->{pageN});
    $self->set_id();
    #lets create the page
    $log->debug("visio page object ($id) created");
    return $self;
}

sub set_id {
    my $self = shift;
    $self->{pageN}->setAttribute('ID',$self->{pageid});
}

sub set_name {
    my $self = shift;
    my $name = shift;
    $self->{pageN}->setAttribute('Name',$name);
}

sub set_heightWidth {
    my $self = shift;
    my $height = shift;
    my $width = shift;
    my $ps= $self->create_pageSheet;
    my $pp= $ps->create_pageProps;
    $pp->set_PageWidth($width);
    $pp->set_PageHeight($height)
}

sub create_pageSheet {
    #if pageSheet doesn't exist, create it;
    my $self = shift;
    if (defined $self->{pageSheet}) {
	return $self->{pageSheet};
    } else {
	$self->{pageSheet} =
	    new Visio::PageSheet($self->{pageN});
	return $self->{pageSheet};
    }
}

sub create_shape {
    my $self = shift;
    my $opts = shift;
    my $fromMaster = $$opts{fromMaster};
    my $shape;
    my $shapesNode = Visio::generic_create_node($self->{pageN},
					 'Shapes'
					 );
    if (defined $self->{maxShapeid}) {
	$self->{maxShapeid} = $self->{maxShapeid} + 1;	
    } else {
	$self->{maxShapeid} = 1;	
    }
    if (defined $fromMaster) {
	$shape= new Visio::Shape($shapesNode,
				 $self->{maxShapeid},
				 {fromMaster=>$fromMaster,
				  pageSelf=>$self
			      }
				 );
    }
    return $shape;
}

sub create_connect {
    my $self = shift;
    my $opts = shift;
    my $connect;
    my $connectsNode = Visio::generic_create_node($self->{pageN},
					 'Connects'
					 );
    $connect = $self->{xmldoc}->createElement('Connect');
    $connectsNode->appendChild($connect);
    return $connect;
}


1;
__END__