1Gtk2::Ex::Utils(3) User Contributed Perl Documentation Gtk2::Ex::Utils(3)
2
6 Gtk2::Ex::Utils - Extra Gtk2 Utilities for working with Gnome2/Gtk2 in
7 Perl.
8
10 use Gtk2::Ex::Utils qw( :main );
11 # do stuff
13 ...
14 # Update the UI and react to pending events
16 process_pending_events();
17 # do more stuff
19 ...
20 # Exit the program with a value of 255 for some reason
22 process_main_exit( 255 );
23
25 This module provides simple utility functions useful for Gnome2/Gtk2
26 Perl programming.
27
29 :all :main :alter :create
30
32 :main
33 process_pending_events ( )
34 For all pending events, run through the main loop once. Useful for
35 long processes to update the user interface.
36 process_main_exit ( [ EXIT_VALUE ] )
38 This will quit the main event loop after all pending events have
39 been given a run through the main loop one last time. Once the UI
40 work is done, exit with the value given or zero. Should the exit
41 value passed be the string 'no-exit', the function will return TRUE
42 instead of exiting.
43 :alter
45 DOUBLE = force_progress_bounds ( DOUBLE )
46 Used with Gtk2 progress bars to ensure a given value is within the
47 0.00 to 1.00 bounds for valid percentages. This function will
48 modify invalid values appropriately to either 0.00 or 1.00 should
49 the value be out of bounds.
50 Gtk2::Label = make_label_wrap_left_centred ( Gtk2::Label )
52 Given a Gtk2::Label will center the alignment, left justify the
53 text, make the label selectable and make the label wrap lines.
54 :create
56 Gtk2::Button = create_mnemonic_icon_button ( ICON, STRING )
57 This will create a new Gtk2::Button, a Gtk2::Image and a label then
58 pack the image and label into an hbox inside the button. The label
59 is new_with_mnemonic and the ICON given can be one of the following
60 types: a stock-id string, the path to an image file, a Gtk2::Image
61 object or a Gtk2::Gdk::Pixbuf object. The button has references to
62 the three components as follows: $button->{HBOX}, $button->{LABEL}
63 and $button->{IMAGE}.
64
66 Please report all bugs to the mailing list.
67
69 If you've got a utility function that is related to Gnome2/Gtk2 Perl,
70 that is not already implemented in here and feel that others may
71 benefit from it's inclusion here, please do not hesitate to send it to
72 the mailing list.
73
75 http://opendoorsoftware.com/lists/gtk2-ex-list
76 gtk2-ex-list@opendoorsoftware.com
77
79 Kevin C. Krinke, <kckrinke@opendoorsoftware.com>
80 James Greenhalgh, <jgreenhalgh@opendoorsoftware.com>
81
83 Gtk2::Ex::Utils - Useful utility functions for working with Gnome2/Gtk2 Perl.
84 Copyright (C) 2005 Open Door Software Inc. <ods@opendoorsoftware.com>
85 This library is free software; you can redistribute it and/or
87 modify it under the terms of the GNU Lesser General Public
88 License as published by the Free Software Foundation; either
89 version 2.1 of the License, or (at your option) any later version.
90 This library is distributed in the hope that it will be useful,
92 but WITHOUT ANY WARRANTY; without even the implied warranty of
93 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
94 Lesser General Public License for more details.
95 You should have received a copy of the GNU Lesser General Public
97 License along with this library; if not, write to the Free Software
98 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
99
101 Hey! The above document had some coding errors, which are explained
102 below:
103 Around line 74:
105 '=item' outside of any '=over'
106 Around line 116:
108 You forgot a '=back' before '=head2'
109 Around line 118:
111 '=item' outside of any '=over'
112 Around line 167:
114 You forgot a '=back' before '=head2'
115 Around line 169:
117 '=item' outside of any '=over'
118 Around line 221:
120 You forgot a '=back' before '=head1'
121perl v5.28.1 2005-02-04 Gtk2::Ex::Utils(3)