The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Gtk2::Ex::MindMapView::Border::Ellipse : Create a elliptical border.

VERSION

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

HEIRARCHY

 Gtk2::Ex::MindMapView::Border
 +----Gtk2::Ex::MindMapView::Border::Ellipse

SYNOPSIS

use Gtk2::Ex::MindMapView::Border::Ellipse;

DESCRIPTION

This module is internal to Gtk2::Ex::MindMapView. It draws a elliptical border for a Gtk2::Ex::MindMapView::Item. This ellipse is instantiated as part of the item creation process in Gtk2::Ex::MindMapView::ItemFactory.

INTERFACE

Properties

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

The content that is placed in the border.

'x' (double)

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

'y' (double)

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

'width' (double)

The width of the ellipse bounding box.

'height' (double)

The width of the ellipse bounding box.

'width-pixels' (double)

The width of the ellipse (in pixels).

'padding-pixels' (double)

The spacing between the ellipse border and the content (in pixels).

Methods

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

Instantiate an elliptical border. You must provide the Gnome2::Canvas::Group on which this border is to place itself. You must also provide a content object.

border_get_image

This method overrides the border_get_image method defined in Border.pm. It instantiates a Gnome2::Canvas::Ellipse.

border_insets

Return the ($top, $left, $bottom, $right) insets for an ellipse. This defined the rectangle inside the ellipse in which content may be placed. At the moment this algoriith is pretty crude. It will be improved.

border_set_x

This method overrides the border_set_x method defined in Border.pm. It sets the value of the border x1 coordinate, and adjusts the x2 value so that the border retains it's width.

border_set_y

This method overrides the border_set_y method defined in Border.pm. It sets the value of the border y1 coordinate, and adjusts the y2 value so that the border retains it's height.

border_set_width

This method overrides the border_set_width method defined in Border.pm. It sets the value of the border x2 coordinate to reflect the new width.

border_set_height

This method overrides the border_set_height method defined in Border.pm. It sets the value of the border y2 coordinate to reflect the new height.

border_set_param

This method overrides the border_set_param method defined in Border.pm. It sets parameters in the Gnome2::Canvas::Ellipse object instantiated by this module.

DIAGNOSTICS

    None.

DEPENDENCIES

None.

BUGS AND LIMITATIONS

The algorithm for calculating the rectangle internal to the ellipse in which to place the content is crude, crude, crude. Currently the height and width values are divided by 4 to get insets. Ugh.

The placement of the resize grip(s) could be improved.

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.