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

AUTHOR

180       Mattia Barbon <mbarbon@cpan.org>
181

LICENSE

183       Alien::wxWidgets
184           Copyright (c) 2005-2012 Mattia Barbon <mbarbon@cpan.org>
185
186           This program is free software; you can redistribute it and/or
187           modify it under the same terms as Perl itself
188
189       inc/bin/patch
190           was taken from the Perl Power Tools distributions
191
192           Copyright (c) 1999 Moogle Stuffy Software <tgy@chocobo.org>
193
194           You may play with this software in accordance with the Perl
195           Artistic License.
196
197           You may use this documentation under the auspices of the GNU
198           General Public License.
199
200       inc/bin/patch.exe
201           was downloaded from
202           http://gnuwin32.sourceforge.net/packages/patch.htm ad is
203           copyrighted by its authors, sources are included inside the inc/src
204           directory.
205
206           This program is free software; you can redistribute it and/or
207           modify it under the terms of the GNU General Public License as
208           published by the Free Software Foundation; either version 2 of the
209           License, or (at your option) any later version.
210
211           This program is distributed in the hope that it will be useful, but
212           WITHOUT ANY WARRANTY; without even the implied warranty of
213           MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
214           General Public License for more details.
215
216           You should have received a copy of the GNU General Public License
217           along with this program; if not, write to the Free Software
218           Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
219           02111-1307  USA
220
221       bundled files from CPAN
222               inc/File/Fetch/Item.pm
223               inc/File/Fetch.pm
224               inc/File/Spec/Unix.pm
225               inc/IPC/Cmd.pm
226               inc/Locale/Maketext/Simple.pm
227               inc/Module/Load/Conditional.pm
228               inc/Module/Load.pm
229               inc/Params/Check.pm
230               inc/Archive/Extract.pm
231
232           Are copyright their respective authors an can be used according to
233           the license specified in their CPAN distributions.
234
235
236
237perl v5.34.0                      2022-01-20               Alien::wxWidgets(3)
Impressum