1Alien::wxWidgets(3)   User Contributed Perl Documentation  Alien::wxWidgets(3)
2
3
4

NAME

6       Alien::wxWidgets - building, finding and using wxWidgets binaries
7

SYNOPSIS

9           use Alien::wxWidgets <options>;
10
11           my $version = Alien::wxWidgets->version;
12           my $config = Alien::wxWidgets->config;
13           my $compiler = Alien::wxWidgets->compiler;
14           my $linker = Alien::wxWidgets->linker;
15           my $include_path = Alien::wxWidgets->include_path;
16           my $defines = Alien::wxWidgets->defines;
17           my $cflags = Alien::wxWidgets->c_flags;
18           my $linkflags = Alien::wxWidgets->link_flags;
19           my $libraries = Alien::wxWidgets->libraries( qw(gl adv core base) );
20           my @libraries = Alien::wxWidgets->link_libraries( qw(gl adv core base) );
21           my @implib = Alien::wxWidgets->import_libraries( qw(gl adv core base) );
22           my @shrlib = Alien::wxWidgets->shared_libraries( qw(gl adv core base) );
23           my @keys = Alien::wxWidgets->library_keys; # 'gl', 'adv', ...
24           my $library_path = Alien::wxWidgets->shared_library_path;
25           my $key = Alien::wxWidgets->key;
26           my $prefix = Alien::wxWidgets->prefix;
27

DESCRIPTION

29       Please see Alien for the manifesto of the Alien namespace.
30
31       In short "Alien::wxWidgets" can be used to detect and get configuration
32       settings from an installed wxWidgets.
33

METHODS

35       load/import
36
37           use Alien::wxWidgets version          => 2.004 ⎪ [ 2.004, 2.005 ],
38                                compiler_kind    => 'gcc' ⎪ 'cl', # Windows only
39                                compiler_version => '3.3', # only GCC for now
40                                toolkit          => 'gtk2',
41                                debug            => 0 ⎪ 1,
42                                unicode          => 0 ⎪ 1,
43                                mslu             => 0 ⎪ 1,
44                                key              => $key,
45                                ;
46
47           Alien::wxWidgets->load( <same as the above> );
48
49       Using "Alien::wxWidgets" without parameters will load a default config‐
50       uration (for most people this will be the only installed confiuration).
51       Additional parameters allow to be more selective.
52
53       If there is no matching configuration the method will "die()".
54
55       In case no arguments are passed in the "use", "Alien::wxWidgets" will
56       try to find a reasonable default configuration.
57
58       Please note that when the version is pecified as "version =" 2.004> it
59       means "any version >= 2.004" while when specified as "version =" [
60       2.004, 2.005 ]> it means "any version => 2.004 and < 2.005".
61
62       key
63
64           my $key = Alien::wxWidgets key;
65
66       Returns an unique key that can be used to reload the currently-loaded
67       configuration.
68
69       version
70
71           my $version = Alien::wxWidgets->version;
72
73       Returns the wxWidgets version for this "Alien::wxWidgets" installation
74       in the form MAJOR + MINOR / 1_000 + RELEASE / 1_000_000 e.g. 2.006002
75       for wxWidgets 2.6.2 and 2.004 for wxWidgets 2.4.0.
76
77       config
78
79           my $config = Alien::wxWidgets->config;
80
81       Returns some miscellaneous configuration informations for wxWidgets in
82       the form
83
84           { toolkit   => 'msw' ⎪ 'gtk' ⎪ 'motif' ⎪ 'x11' ⎪ 'cocoa' ⎪ 'mac',
85             debug     => 1 ⎪ 0,
86             unicode   => 1 ⎪ 0,
87             mslu      => 1 ⎪ 0,
88             }
89
90       include_path
91
92           my $include_path = Alien::wxWidgets->include_path;
93
94       Returns the include paths to be used in a format suitable for the com‐
95       piler (usually something like "-I/usr/local/include
96       -I/opt/wx/include").
97
98       defines
99
100           my $defines = Alien::wxWidgets->defines;
101
102       Returns the compiler defines to be used in a format suitable for the
103       compiler (usually something like "-D__WXDEBUG__ -DFOO=bar").
104
105       c_flags
106
107           my $cflags = Alien::wxWidgets->c_flags;
108
109       Returns additional compiler flags to be used.
110
111       compiler
112
113           my $compiler = Alien::wxWidgets->compiler;
114
115       Returns the (C++) compiler used for compiling wxWidgets.
116
117       linker
118
119           my $linker = Alien::wxWidgets->linker;
120
121       Returns a linker suitable for linking C++ binaries.
122
123       link_flags
124
125           my $linkflags = Alien::wxWidgets->link_flags;
126
127       Returns additional link flags.
128
129       libraries
130
131           my $libraries = Alien::wxWidgets->libraries( qw(gl adv core base) );
132
133       Returns link flags for linking the libraries passed as arguments. This
134       usually includes some search path specification in addition to the
135       libraries themselves. The caller is responsible for the correct order
136       of the libraries.
137
138       link_libraries
139
140           my @libraries = Alien::wxWidgets->link_libraries( qw(gl adv core base) );
141
142       Returns a list of linker flags that can be used to link the libraries
143       passed as arguments.
144
145       import_libraries
146
147           my @implib = Alien::wxWidgets->import_libraries( qw(gl adv core base) );
148
149       Windows specific. Returns a list of import libraries corresponding to
150       the libraries passed as arguments.
151
152       shared_libraries
153
154           my @shrlib = Alien::wxWidgets->shared_libraries( qw(gl adv core base) );
155
156       Returns a list of shared libraries corresponding to the libraries
157       passed as arguments.
158
159       library_keys
160
161           my @keys = Alien::wxWidgets->library_keys;
162
163       Returns a list of keys that can be passed to "shared_libraries",
164       "import_libraries" and "link_libraries".
165
166       library_path
167
168           my $library_path = Alien::wxWidgets->shared_library_path;
169
170       Windows specific. Returns the path at which the private copy of wxWid‐
171       gets libraries has been installed.
172
173       prefix
174
175           my $prefix = Alien::wxWidgets->prefix;
176
177       Returns the install prefix for wxWidgets.
178
179       show_configurations
180
181           Alien::wxWidgets->show_configurations( %filters );
182
183       Prints a list of available configurations (mainly useful for interac‐
184       tive use/debugging).
185
186       get_configurations
187
188          my $configs = Alien::wxWidgets->get_configurations( %filters );
189
190       Returns a list of configurations matching the given filters.
191

AUTHOR

193       Mattia Barbon <mbarbon@cpan.org>
194

LICENSE

196       Alien::wxWidgets
197           Copyright (c) 2005, 2006 Mattia Barbon <mbarbon@cpan.org>
198
199           This program is free software; you can redistribute it and/or mod‐
200           ify it under the same terms as Perl itself
201
202       inc/bin/patch
203           was taken from the Perl Power Tools distributions
204
205           Copyright (c) 1999 Moogle Stuffy Software <tgy@chocobo.org>
206
207           You may play with this software in accordance with the Perl Artis‐
208           tic License.
209
210           You may use this documentation under the auspices of the GNU Gen‐
211           eral Public License.
212
213       inc/bin/patch.exe
214           was downloaded from http://gnuwin32.sourceforge.net/pack‐
215           ages/patch.htm ad is copyrighted by its authors.
216
217           This program is free software; you can redistribute it and/or mod‐
218           ify it under the terms of the GNU General Public License as pub‐
219           lished by the Free Software Foundation; either version 2 of the
220           License, or (at your option) any later version.
221
222           This program is distributed in the hope that it will be useful, but
223           WITHOUT ANY WARRANTY; without even the implied warranty of MER‐
224           CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Gen‐
225           eral Public License for more details.
226
227           You should have received a copy of the GNU General Public License
228           along with this program; if not, write to the Free Software Founda‐
229           tion, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
230
231       bundled files from CPAN
232               inc/File/Fetch/Item.pm
233               inc/File/Fetch.pm
234               inc/File/Spec/Unix.pm
235               inc/IPC/Cmd.pm
236               inc/Locale/Maketext/Simple.pm
237               inc/Module/Load/Conditional.pm
238               inc/Module/Load.pm
239               inc/Params/Check.pm
240               inc/Archive/Extract.pm
241
242           Are copyright their respective authors an can be used according to
243           the license specified in their CPAN distributions.
244
245
246
247perl v5.8.8                       2007-03-31               Alien::wxWidgets(3)