1Wx::Api(3)            User Contributed Perl Documentation           Wx::Api(3)
2
3
4

NAME

6       API - wxPerl extension API documentation
7

DESCRIPTION

9   WXPL_API_VERSION
10       An integer value used to differentiate wxPerl versions, it is
11       guaranteed to be non-decreasing. wxPerl 0.15 value is 0150; wxPerl 1.00
12       value will be 1000, wxPerl 2.12 value will be 2120.
13
14       Introduced in wxPerl 0.15
15
16   wxPli_create_evthandler
17         SV* wxPli_create_evthandler( pTHX_ wxEvtHandler* object,
18                                      const char* classname );
19
20       Creates a new hash reference, blessed into "classname", and
21       binds"object" to it.
22
23       Introduced in wxPerl 0.16
24
25   wxPli_evthandler_2_sv
26         SV* wxPli_evthandler_2_sv( pTHX_ SV* var, wxEvtHandler* evth );
27
28       Same as wxPli_object_2_sv, but works with "wxEvtHandler"-derived
29       classes, which includes all "wxWindow"-derived classes.
30
31       Introduced in wxPerl 0.16
32
33   wxPli_get_class
34         const char* wxPli_get_class( pTHX_ SV* ref );
35
36       The C++ equivalent of "$class = ref( $obj ) || $obj"; the pointer
37       returned by the function is potentially temporary.
38
39   wxPli_non_object_2_sv
40         SV* wxPli_non_object_2_sv( pTHX_ SV* var, void* data, const char* package );
41
42       Binds a generic pointer to an "SV*", and returns it; the new binding is
43       blessed into the given "package".
44
45       Introduced before wxPerl 0.14
46
47   wxPli_object_2_sv
48         SV* wxPli_object_2_sv( pTHX_ SV* var, wxObject* object );
49
50       Binds a "wxObject*" pointer to an "SV*", and returns it.  If the object
51       is already bound to an "SV*", returns a reference to the existing
52       "SV*", otherwise, it creates a new binding; in the latter case, the new
53       "SV*" is blessed into a package obtained through the wxWidgets RTTI
54       system.
55
56       Introduced before wxPerl 0.14
57
58   wxPli_push_arguments
59         void wxPli_push_arguments( pTHX_ SV*** stack, const char* argtypes, ... );
60
61         // example
62         wxPli_push_arguments( aTHX_ SP, "iP", 12, "foo" );
63
64       Pushes a variable number of arguments on the perl stack, it is useful
65       for passing parameters to a Perl function. The "argtypes" string
66       describes the types of subsequent arguments, each character of the
67       string specifying the type of a single argument. Possible values are:
68
69       b   a "bool" value
70
71       i   an "int" value
72
73       l   a "long" value
74
75       L   an "unsigned long" value
76
77       d   a "double" value
78
79       p   a "char*" value
80
81       w   a "wxChar*" value
82
83       P   a "wxString*" value
84
85       S   a "SV*", a copy of the SV is pushed on the stack
86
87       s   a "SV*", the pointer itself is pushed on the stack
88
89       O   a "wxObject*", the function will internally call
90           "wxPli_object_2_sv" and push the result on the stack.
91
92       o   this is the only type that uses 2 parameters: the first is a
93           "void*", the second a "char*"; the function will internally call
94           "wxPli_non_object_2_sv" and push the result on the stack.
95
96       Introduced before wxPerl 0.14
97
98   wxPli_sv_2_object
99         void* wxPli_sv_2_object( pTHX_ SV* scalar, const char* classname );
100
101       Extracts a bound pointer from a perl reference, checking that the
102       reference belongs to the correct class (die()s on failure), and returns
103       it. If "classname" is "NULL", the check is not done.
104
105       Introduced before wxPerl 0.14
106
107   wxPli_wxChar_2_sv
108         SV* wxPli_wxChar_2_sv( pTHX_ const wxChar* str, SV* out );
109
110       Stores a string into a "SV*", and returns the "SV*".
111
112       Introduced before wxPerl 0.14
113
114   wxPli_wxString_2_sv
115         SV* wxPli_wxString_2_sv( pTHX_ const wxString& str, SV* out );
116
117       Stores a string into a "SV*", and returns the "SV*".
118
119       Introduced before wxPerl 0.14
120

AUTHOR

122       Mattia Barbon <mbarbon at cpan dot org>
123
124
125
126perl v5.38.0                      2023-07-21                        Wx::Api(3)