NAME

Gtk2::Ex::MindMapView::Border: Base class for border objects.

VERSION

This document describes Gtk2::Ex::MindMapView::Border version 0.0.1

SYNOPSIS

use base 'Gtk2::Ex::MindMapView::Border';

DESCRIPTION

This module is internal to Gtk2::Ex::MindMapView. It is the base class for objects that draw borders and offers several classes that are to be overidden.

INTERFACE

Properties

'content' (Gtk2::Ex::MindMapView::Content)

The content to be placed in this border.

'group' (Gnome2::Canvas::Group)

The canvas group on which the border will be drawn.

'x' (double)

The x-coordinate of the upper left corner of the bounding box of this border.

'y' (double)

The y-coordinate of the upper left corner of the bounding box of this border.

'width' (double)

The width of the bounding box of this border.

'height' (double)

The height of the bounding box of this border.

Methods

new(group=>$group, content=>$content, ...)

Instantiate a border. You must provide the Gnome2::Canvas::Group on which this border is to place itself, and also a content object, Gtk2::Ex::MindMapView::Content.

border_get_image()

This method must be overridden. You defined the image for your border here.

border_insets ()

Return the ($top,$left,$bottom,$right) insets for the border. This method may be overridden.

border_set_x($value)

This method must be overridden. It sets the value of the border x coordinate.

border_set_y($value)

This method must be overridden. It sets the value of the border y coordinate.

border_set_width($value)

This method must be overridden. It sets the value of the border width.

border_set_height($value)

This method must be overridden. It sets the value of the border height.

border_set_param($name, $value)

This method may optionally be overridden to pass values to the object created by border_get_image.

get($name)

Returns the value of a property.

get_min_width()

Returns the minimum height of the border.

get_min_height()

Returns the minimum width of the border.

get_connection_point($side)

Returns the point on the border that is used to draw the connection to other Gtk2::Ex::MindMapView::Items.

Items may connect to the left or right hand side of a border. The $side may have the value 'left' or 'right'.

This method is called by Gtk2::Ex::MindMapView::Connection.

reparent($group)

When a border is passed to a Gtk2::Ex::MindMapView::Item, the item places the border in it's own Gnome2::Canvas::Group using this reparent method.

set(property=>$value

Sets the value of a property. See the properties list above.

DIAGNOSTICS

Unexpected value for group. Valid is: Gnome2::Canvas::Group

You must pass in a Gnome2::Canvas::Group object on which this border will draw itself.

Unexpected value for content. Valid is: Gtk2::Ex::MindMapView::Content

You must pass in a Gtk2::Ex::MindMapView::Content object as content.

You must supply a border image by overriding 'border_get_image'

You must override the border_get_image method with your own method that returns a Gnome2::Canvas::Item that defines the border.

You must set the border x coordinate by overriding 'border_set_x'.

You must override the border_set_x method with your own method that sets the x-coordinate for the Gnome2::Canvas::Item you created with border_get_image.

You must set the border y coordinate by overriding 'border_set_y'.

You must override the border_set_y method with your own method that sets the y-coordinate for the Gnome2::Canvas::Item you created with border_get_image.

You must set the border width by overriding 'border_set_width'.

You must override the border_set_width method with your own method that sets the width for the Gnome2::Canvas::Item you created with border_get_image.

You must set the border height by overriding 'border_set_height'.

You must override the border_set_height method with your own method that sets the height for the Gnome2::Canvas::Item you created with border_get_image.

DEPENDENCIES

None.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-gtk2-ex-mindmapview@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR

James Muir <hemlock@vtlink.net>

LICENCE AND COPYRIGHT

Copyright (c) 2006, James Muir <hemlock@vtlink.net>. All rights reserved.

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

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.