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

NAME

Gtk2::Ex::MindMapView::ItemFactory - Maker of standard view items.

VERSION

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

SYNOPSIS

use Gtk2::Ex::MindMapView::ItemFactory;

DESCRIPTION

This factory make Gtk2::Ex::MindMapView::Items of various kinds. Four "hotspots" are applied to each item that enable resizing of the rectangle and expansion/collapse of the balanced graph.

The following border types are supported:

Gtk2::Ex::MindMapView::Border::RoundedRect - Displays a rounded rectangle border.

Gtk2::Ex::MindMapView::Border::Rectangle - Displays a rectangular border.

Gtk2::Ex::MindMapView::Border::Ellipse - Displays an elliptical border.

The following content types are supported:

Gtk2::Ex::MindMapView::Content::EllipsisText - Displays text with optional ellipsis (...)

Gtk2::Ex::MindMapView::Content::Picture - Displays a picture in a pixbuf.

Gtk2::Ex::MindMapView::Content::Uri - Displays a URI.

INTERFACE

Properties

'border' (string)

A string describing the type of border object to be instantiated. For example, it might be: 'Gtk2::Ex::MindMapView::Border::RoundedRect'.

'browser' (string)

A string describing the command to execute with a given URI argument.

'content' (string)

A string describing the type of content object to be instantiated. For example, it might be: 'Gtk2::Ex::MindMapView::Content::EllipsisText'.

'fill_color_gdk' (Gtk2::Gdk::Color)

The color with which to fill the item.

'font_desc' (Gtk2::Pango::FontDescription)

The font to use when showing the content.

'hotspot_color_gdk' (Gtk2::Gdk::Color)

The color of a hotspot that is to be shown when the hotspot is engaged.

'outline_color_gdk' (Gtk2::Gdk::Color)

The could with which to outline the item

'pixbuf' (Gtk2::Gdk::Pixbuf)

An image to be displayed in a Gtk2::Ex::MindMapView::Content::Picture.

'text' (string)

The text to display in a Gtk2::Ex::MindMapView::Content::EllipsisText or Gtk2::Ex::MindMapView::Content::Uri.

'text_color_gdk' (Gtk2::Gdk::Color)

The color of the text to be displayed.

'uri' (string)

The URI/URL to be referenced by the browser when the user clicks on a link in the mind map.

'view' (Gtk2::Ex::MindMapView)

The canvas on which to draw mind map items.

Methods

new (view=>$view, ...)

Constructor for this factory. Pass in a Gtk2::Ex::MindMapView argument, and optionally: font_desc, fill_color_gdk, text_color_gdk, outline_color_gdk, hotspot_color_gdk.

create_item (border=>$border_type, content=>$content_type, ...)

Creates a new Gtk2::Ex::MindMapView::Item with the specified border and content, and optionally: font_desc, fill_color_gdk, text_color_gdk, outline_color_gdk, hotspot_color_gdk, text, browser, uri, pixbuf.

DIAGNOSTICS

Invalid Gtk2::Ex::MindMapView argument.

You must pass in a Gtk2::Ex::MindMapView argument as follows: $factory = Gtk2::Ex::MindMapView::ItemFactory->new(view=>$view);

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.