File: gbsizer.py

package info (click to toggle)
wxpython4.0 4.2.3%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 221,752 kB
  • sloc: cpp: 962,555; python: 230,573; ansic: 170,731; makefile: 51,756; sh: 9,342; perl: 1,564; javascript: 584; php: 326; xml: 200
file content (187 lines) | stat: -rw-r--r-- 7,605 bytes parent folder | download | duplicates (2)
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
#---------------------------------------------------------------------------
# Name:        etg/gbsizer.py
# Author:      Robin Dunn
#
# Created:     06-Dec-2011
# Copyright:   (c) 2011-2020 by Total Control Software
# License:     wxWindows License
#---------------------------------------------------------------------------

import etgtools
import etgtools.tweaker_tools as tools

PACKAGE   = "wx"
MODULE    = "_core"
NAME      = "gbsizer"   # Base name of the file to generate to for this script
DOCSTRING = ""

# The classes and/or the basename of the Doxygen XML files to be processed by
# this script.
ITEMS  = [ "wxGBPosition",
           "wxGBSpan",
           "wxGBSizerItem",
           "wxGridBagSizer",
           ]

#---------------------------------------------------------------------------

def run():
    # Parse the XML file(s) building a collection of Extractor objects
    module = etgtools.ModuleDef(PACKAGE, MODULE, NAME, DOCSTRING)
    etgtools.parseDoxyXML(module, ITEMS)

    #-----------------------------------------------------------------
    # Tweak the parsed meta objects in the module object as needed for
    # customizing the generated code and docstrings.

    c = module.find('wxGBPosition')
    assert isinstance(c, etgtools.ClassDef)

    # allow a 2 element sequence to be auto converted
    c.convertFromPyObject = tools.convertTwoIntegersTemplate('wxGBPosition')

    c.addCppMethod('PyObject*', 'Get', '()', """\
        wxPyThreadBlocker blocker;
        return sipBuildResult(0, "(ii)", self->GetRow(), self->GetCol());
        """,
        pyArgsString="() -> (row, col)",
        briefDoc="Return the row and col properties as a tuple.")
    c.addCppMethod('void', 'Set', '(int row=0, int col=0)', """\
        self->SetRow(row);
        self->SetCol(col);
        """,
        briefDoc="Set both the row and column properties.")

    tools.addGetIMMethodTemplate(module, c, ['row', 'col'])


    # Add sequence protocol methods and other goodies
    c.addPyMethod('__str__', '(self)',             'return str(self.Get())')
    c.addPyMethod('__repr__', '(self)',            'return "wx.GBPosition"+str(self.Get())')
    c.addPyMethod('__len__', '(self)',             'return len(self.Get())')
    c.addPyMethod('__nonzero__', '(self)',         'return self.Get() != (0,0)')
    c.addPyMethod('__bool__', '(self)',            'return self.Get() != (0,0)')
    c.addPyMethod('__reduce__', '(self)',          'return (GBPosition, self.Get())')
    c.addPyMethod('__getitem__', '(self, idx)',    'return self.Get()[idx]')
    c.addPyMethod('__setitem__', '(self, idx, val)',
                  """\
                  if idx == 0: self.Row = val
                  elif idx == 1: self.Col = val
                  else: raise IndexError
                  """)
    c.addPyCode('GBPosition.__safe_for_unpickling__ = True')

    # In addition to the normal Row and Col properties let's also have lower
    # case versions.
    c.addProperty("Row GetRow SetRow")
    c.addProperty("Col GetCol SetCol")
    c.addProperty("row GetRow SetRow")
    c.addProperty("col GetCol SetCol")


    #-----------------------------------------------------------------
    c = module.find('wxGBSpan')
    assert isinstance(c, etgtools.ClassDef)

    # allow a 2 element sequence to be auto converted
    c.convertFromPyObject = tools.convertTwoIntegersTemplate('wxGBSpan')

    c.addCppMethod('PyObject*', 'Get', '()', """\
        wxPyThreadBlocker blocker;
        return sipBuildResult(0, "(ii)", self->GetRowspan(), self->GetColspan());
        """,
        pyArgsString="() -> (rowspan, colspan)",
        briefDoc="Return the rowspan and colspan properties as a tuple.")
    c.addCppMethod('void', 'Set', '(int rowspan=0, int colspan=0)', """\
        self->SetRowspan(rowspan);
        self->SetColspan(colspan);
        """,
        briefDoc="Set both the rowspan and colspan properties.")

    tools.addGetIMMethodTemplate(module, c, ['rowspan', 'colspan'])

    # Add sequence protocol methods and other goodies
    c.addPyMethod('__str__', '(self)',             'return str(self.Get())')
    c.addPyMethod('__repr__', '(self)',            'return "wx.GBSpan"+str(self.Get())')
    c.addPyMethod('__len__', '(self)',             'return len(self.Get())')
    c.addPyMethod('__nonzero__', '(self)',         'return self.Get() != (0,0)')
    c.addPyMethod('__bool__', '(self)',            'return self.Get() != (0,0)')
    c.addPyMethod('__reduce__', '(self)',          'return (GBSpan, self.Get())')
    c.addPyMethod('__getitem__', '(self, idx)',    'return self.Get()[idx]')
    c.addPyMethod('__setitem__', '(self, idx, val)',
                  """\
                  if idx == 0: self.Rowspan = val
                  elif idx == 1: self.Colspan = val
                  else: raise IndexError
                  """)
    c.addPyCode('GBSpan.__safe_for_unpickling__ = True')

    # In addition to the normal Rowspan and Colspan properties let's also have lower
    # case versions.
    c.addProperty("Rowspan GetRowspan SetRowspan")
    c.addProperty("Colspan GetColspan SetColspan")
    c.addProperty("rowspan GetRowspan SetRowspan")
    c.addProperty("colspan GetColspan SetColspan")


    #-----------------------------------------------------------------
    c = module.find('wxGBSizerItem')
    assert isinstance(c, etgtools.ClassDef)

    # transfer ownership of a sizer if the item is managing one
    c.find('wxGBSizerItem.sizer').transfer = True

    # deal with userData args in the ctors
    for m in c.find('wxGBSizerItem').all():
        if isinstance(m, etgtools.MethodDef) and m.findItem('userData'):
            m.find('userData').transfer = True
            m.find('userData').type = 'wxPyUserData*'

    # ignore some overloads that would be ambiguous from Python
    c.find('GetPos').findOverload('row').ignore()
    c.find('GetSpan').findOverload('rowspan').ignore()

    c.find('GetEndPos.row').out = True
    c.find('GetEndPos.col').out = True

    #-----------------------------------------------------------------
    c = module.find('wxGridBagSizer')
    assert isinstance(c, etgtools.ClassDef)

    tools.fixSizerClass(c)

    for func in c.findAll('Add'):
        if func.findItem('sizer'):
            func.find('sizer').transfer = True
        if func.findItem('userData'):
            func.find('userData').transfer = True
            func.find('userData').type = 'wxPyUserData*'
        if func.findItem('item'):
            func.find('item').transfer = True

    c.addCppMethod('wxSizerItem*', 'Add',
                   '(const wxSize& size, const wxGBPosition& pos, '
                     'const wxGBSpan& span = wxDefaultSpan, int flag = 0, '
                     'int border = 0, wxObject* userData /Transfer/ = NULL)',
        doc="Add a spacer using a :class:`Size` object.",
        body="return self->Add(size->x, size->y, *pos, *span, flag, border, userData);")


    c.addPyCode(
        "GridBagSizer.CheckForIntersectionPos = wx.deprecated(GridBagSizer.CheckForIntersection, 'Use CheckForIntersection instead.')")

    # TODO: In Classic we had GetChildren return a list of wxGBSizerItems (in
    # a faked out way). Figure out how to do that here too....

    #module.addItem(
    #    tools.wxListWrapperTemplate('wxGBSizerItemList', 'wxGBSizerItem', module, 'wxSizerItem'))


    #-----------------------------------------------------------------
    tools.doCommonTweaks(module)
    tools.runGenerators(module)


#---------------------------------------------------------------------------
if __name__ == '__main__':
    run()