File: wx.lib.checkbox.DefineNativeCheckBoxBitmapsMixin.txt

package info (click to toggle)
wxpython4.0 4.2.0%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 232,540 kB
  • sloc: cpp: 958,937; python: 233,059; ansic: 150,441; makefile: 51,662; sh: 8,687; perl: 1,563; javascript: 584; php: 326; xml: 200
file content (148 lines) | stat: -rw-r--r-- 6,239 bytes parent folder | download
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
.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2020 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc

.. currentmodule:: wx.lib.checkbox

.. highlight:: python



.. _wx.lib.checkbox.DefineNativeCheckBoxBitmapsMixin:

==========================================================================================================================================
|phoenix_title|  **wx.lib.checkbox.DefineNativeCheckBoxBitmapsMixin**
==========================================================================================================================================

Inherit this mixin in your :class:`wx.Window` based subclass to easily
define the native CheckBox Bitmaps as attributes which can then be used
to customize a widgets appearance/functionality with.

Sample example usage::

    class MyCheckListBoxSTC(wx.stc.StyledTextCtrl, DefineNativeCheckBoxBitmapsMixin):
        '''Customized StyledTextCtrl Setup like a CheckListBox.'''
        def __init__(self, parent, id=wx.ID_ANY,
                     pos=wx.DefaultPosition, size=wx.DefaultSize,
                     style=0, name='styledtextctrl'):
            wx.stc.StyledTextCtrl.__init__(self, parent, id, pos, size, style, name)

            # Define the checkbox bitmaps as attributes.
            self.DefineNativeCheckBoxBitmaps()
            # After the bitmaps have become attributes you can easily snag
            # them all later on from inside a method with this inherited method.
            ## self.checkbox_bitmaps = self.GetNativeCheckBoxBitmaps()

            # Setup a margin to hold bookmarks.
            self.SetMarginType(1, wx.stc.STC_MARGIN_SYMBOL)
            self.SetMarginSensitive(1, True)
            self.SetMarginWidth(1, 16)
            # Define the bookmark images.
            self.MarkerDefineBitmap(0, self.native_checkbox_unchecked_bmp)
            self.MarkerDefineBitmap(1, self.native_checkbox_checked_bmp)

            # ... do something with the bitmaps when you click the margin event.



|

|class_hierarchy| Class Hierarchy
=================================

.. raw:: html

   <div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
   <img id="toggleBlock-trigger" src="_static/images/closed.png"/>
   Inheritance diagram for class <strong>DefineNativeCheckBoxBitmapsMixin</strong>:
   </div>
   <div id="toggleBlock-summary" style="display:block;"></div>
   <div id="toggleBlock-content" style="display:none;">
   <p class="graphviz">
   <center><img src="_static/images/inheritance/wx.lib.checkbox.DefineNativeCheckBoxBitmapsMixin_inheritance.png" alt="Inheritance diagram of DefineNativeCheckBoxBitmapsMixin" usemap="#dummy" class="inheritance"/></center>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.checkbox.DefineNativeCheckBoxBitmapsMixin.html" title="wx.lib.checkbox.DefineNativeCheckBoxBitmapsMixin" alt="" coords="5,5,376,35"/> </map> 
   </p>
   </div>

|


|method_summary| Methods Summary
================================

===================================================================================== ================================================================================
:meth:`~wx.lib.checkbox.DefineNativeCheckBoxBitmapsMixin.DefineNativeCheckBoxBitmaps` Define native checkbox bitmaps as attributes. Returns ``True`` if all bitmaps was defined Ok.
:meth:`~wx.lib.checkbox.DefineNativeCheckBoxBitmapsMixin.GetNativeCheckBoxBitmaps`    Get a tuple of the defined checkbox bitmaps.
===================================================================================== ================================================================================


|


|api| Class API
===============


.. class:: DefineNativeCheckBoxBitmapsMixin()

   Inherit this mixin in your :class:`wx.Window` based subclass to easily
   define the native CheckBox Bitmaps as attributes which can then be used
   to customize a widgets appearance/functionality with.
   
   Sample example usage::
   
       class MyCheckListBoxSTC(wx.stc.StyledTextCtrl, DefineNativeCheckBoxBitmapsMixin):
           '''Customized StyledTextCtrl Setup like a CheckListBox.'''
           def __init__(self, parent, id=wx.ID_ANY,
                        pos=wx.DefaultPosition, size=wx.DefaultSize,
                        style=0, name='styledtextctrl'):
               wx.stc.StyledTextCtrl.__init__(self, parent, id, pos, size, style, name)
   
               # Define the checkbox bitmaps as attributes.
               self.DefineNativeCheckBoxBitmaps()
               # After the bitmaps have become attributes you can easily snag
               # them all later on from inside a method with this inherited method.
               ## self.checkbox_bitmaps = self.GetNativeCheckBoxBitmaps()
   
               # Setup a margin to hold bookmarks.
               self.SetMarginType(1, wx.stc.STC_MARGIN_SYMBOL)
               self.SetMarginSensitive(1, True)
               self.SetMarginWidth(1, 16)
               # Define the bookmark images.
               self.MarkerDefineBitmap(0, self.native_checkbox_unchecked_bmp)
               self.MarkerDefineBitmap(1, self.native_checkbox_checked_bmp)
   
               # ... do something with the bitmaps when you click the margin event.

   .. method:: DefineNativeCheckBoxBitmaps(self)

      Define native checkbox bitmaps as attributes. Returns ``True`` if all bitmaps was defined Ok.
      
      bitmaps defined::
      
          self.native_checkbox_unchecked_bmp
          self.native_checkbox_unchecked_disabled_bmp
          self.native_checkbox_checked_bmp
          self.native_checkbox_checked_disabled_bmp
          self.native_checkbox_3state_bmp
          self.native_checkbox_3state_disabled_bmp
          self.native_checkbox_current_bmp
          self.native_checkbox_pressed_bmp
      
      :rtype: bool


   .. method:: GetNativeCheckBoxBitmaps(self)

      Get a tuple of the defined checkbox bitmaps.
      
      :rtype: tuple