/ 
Gtk2-Ex-MindMapView-0.000001
River stage zero No dependents
/ Gtk2::Ex::MindMapView::HotSpot::ToggleFactory

NAME

Gtk2::Ex::MindMapView::HotSpot::ToggleFactory - Maker of standard toggle items.

VERSION

This document describes Gtk2::Ex::MindMapView::HotSpot::ToggleFactory version 0.0.1

SYNOPSIS

use Gtk2::Ex::MindMapView::HotSpot::ToggleFactory;

DESCRIPTION

This factory makes toggles that are used to expand or collapse the tree of items shown in the mind map.

The following types of toggles are currently supported:

Gtk2::Ex::MindMapView::HotSpot::Toggle::Round - The standard round toggle.

This factory is used by the Gtk2::Ex::MindMapView::ItemFactory.

INTERFACE

Properties

'item' (Gtk2::Ex::MindMapView::Item)

The item to attach the grip to.

'border' (Gtk2::Ex::MindMapView::Border)

The border that is used to determine the type of toggle to create.

'side' (string)

The side of the item to attach to. May be: left or right.

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

The color of the toggle.

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

The color of the toggle outline.

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

The color of the toggle when it is engaged.

Methods

new ( ...)

Constructor for the toggle factory.

create_toggle (item=>$item, border=>$border, side=>$side, ...)

Creates a new Gtk2::Ex::MindMapView::HotSpot::Toggle given the Gtk2::Ex::MindMapView::Item that the toggle will attach to. The Gtk2::Ex::MindMapView::Border is used to determine what toggle to return to the caller. The side may be left or right.

DIAGNOSTICS

Invalid item. Item must be a 'Gtk2::Ex::MindMapView::Item'

You must pass in a Gtk2::Ex::MindMapView::Item argument.

Invalid side. Must be 'right' or 'left'

You must set the side to be either: left or right.

Unexpected border: $border

You must give one of the known border types at this time.

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.