blob: 87d39113d4f057c3c0f7309f35e58c48e5eaea95 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
Shiboken
********
.. ifconfig:: output_format == 'html'
Shiboken is a fundamental piece on the `Qt for Python <../index.html>`__ project that serves two purposes:
.. ifconfig:: output_format == 'qthelp'
Shiboken is a fundamental piece on the `Qt for Python <../pyside6/index.html>`__ project that serves two purposes:
* Generator_: Extract information from C or C++ headers and generate CPython_ code that allow
to bring C or C++ projects to Python. This process uses a library called ApiExtractor_ which
internally uses Clang_.
* Module_: An utility Python module that exposed new Python types, functions to handle pointers,
among other things, that is written in CPython_ and can use independently of the generator.
.. _Generator: shibokengenerator.html
.. _Module: shibokenmodule.html
.. _CPython: https://github.com/python/cpython
.. _Clang: https://clang.llvm.org/
.. _ApiExtractor: typesystem.html
Documentation
=============
.. ifconfig:: output_format == 'html'
.. panels::
:body: text-center
:container: container-lg pb-3
:column: col-lg-4 col-md-4 col-sm-6 col-xs-12 p-2
Install and build from source.
+++
.. link-button:: gettingstarted
:type: ref
:text: Getting Started
:classes: btn-qt btn-block stretched-link
---
Binding generator executable.
+++
.. link-button:: shibokengenerator
:type: ref
:text: Shiboken Generator
:classes: btn-qt btn-block stretched-link
---
Python utility module.
+++
.. link-button:: shibokenmodule
:type: ref
:text: Shiboken Module
:classes: btn-qt btn-block stretched-link
---
Reference and functionallities.
+++
.. link-button:: typesystem
:type: ref
:text: Type System
:classes: btn-qt btn-block stretched-link
---
Using Shiboken.
+++
.. link-button:: examples/index
:type: ref
:text: Examples
:classes: btn-qt btn-block stretched-link
---
Known issues and FAQ.
+++
.. link-button:: considerations
:type: ref
:text: Considerations
:classes: btn-qt btn-block stretched-link
.. ifconfig:: output_format == 'qthelp'
<table class="special">
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<tr>
<td><a href="gettingstarted.html"><p><strong>Getting Started</strong><br/>Install and build from source.</p></a></td>
<td><a href="shibokengenerator.html"><p><strong>Shiboken Generator</strong><br/>Binding generator executable.</p></a></td>
<td><a href="shibokenmodule.html"><p><strong>Shiboken Module</strong><br/>Python utility module.</p></a></td>
</tr>
<tr>
<td><a href="typesystem.html"><p><strong>Type System</strong><br/>Reference and functionality.</p></a></td>
<td><a href="examples/index.html"><p><strong>Examples</strong><br/>Using Shiboken.</p></a></td>
<td><a href="considerations.html"><p><strong>Considerations</strong><br/>Known issues and FAQ.</p></a></td>
</tr>
</table>
.. toctree::
:hidden:
:glob:
gettingstarted.rst
shibokengenerator.rst
shibokenmodule.rst
typesystem.rst
examples/index.rst
considerations.rst
|
