python-kiwi 1.9.22-2 / usr / share / doc / python-kiwi / api / kiwi.utils.html

This file is indexed.

/usr/share/doc/python-kiwi/api/kiwi.utils.html is in python-kiwi 1.9.22-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
        <html><head>
        <link rel="stylesheet" type="text/css" href="apidocs.css"/>
        <title>API docs for &ldquo;kiwi.utils&rdquo;</title>
        </head>
        <body><h1 class="module">Module k.utils</h1><span id="part">Part of <a href="kiwi.html">kiwi</a></span><div class="toplevel"><div><p>GObject utilities and addons</p>
</div></div><table class="children"><tr class="function"><td>Function</td><td><a href="#kiwi.utils.list_properties">list_properties</a></td><td><div><p>Return a list of all properties for GType gtype, excluding</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.utils.type_register">type_register</a></td><td><div><p>Register the type, but only if it's not already registered</p>
</div></td></tr><tr class="class"><td>Class</td><td><a href="kiwi.utils._GObjectClassInittableMetaType.html">_GObjectClassInittableMetaType</a></td><td><span class="undocumented">Undocumented</span></td></tr><tr class="class"><td>Class</td><td><a href="kiwi.utils._GobjectClassInittableObject.html">_GobjectClassInittableObject</a></td><td><span class="undocumented">Undocumented</span></td></tr><tr class="class"><td>Class</td><td><a href="kiwi.utils.PropertyMeta.html">PropertyMeta</a></td><td><div><p>Metaclass that takes into account properties and signals</p>
</div></td></tr><tr class="class"><td>Class</td><td><a href="kiwi.utils.PropertyObject.html">PropertyObject</a></td><td><div><p>I am an object which maps GObject properties to attributes</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.utils.gsignal">gsignal</a></td><td><div><p>Add a GObject signal to the current object.</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.utils._max">_max</a></td><td><span class="undocumented">Undocumented</span></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.utils.gproperty">gproperty</a></td><td><div><p>Add a GObject property to the current object.</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.utils.quote">quote</a></td><td><div><p>Similar to urllib.quote but for glibs GMarkup</p>
</div></td></tr></table>
            <div class="function">
            <div class="functionHeader">def <a name="kiwi.utils.list_properties">list_properties(gtype, parent=True):</a></div>
            <div class="functionBody"><div><p>Return a list of all properties for GType gtype, excluding properties in
parent classes</p>
</div></div>
            </div>
            <div class="function">
            <div class="functionHeader">def <a name="kiwi.utils.type_register">type_register(gtype):</a></div>
            <div class="functionBody"><div><p>Register the type, but only if it's not already registered</p>
</div><div class="metadata"><span class="tag">param</span> <span class="arg">gtype</span><span class="body">the class to register
</span></div></div>
            </div>
            <div class="function">
            <div class="functionHeader">def <a name="kiwi.utils.gsignal">gsignal(name, *args, **kwargs):</a></div>
            <div class="functionBody"><div><p>Add a GObject signal to the current object. It current supports the 
following types:</p>
<ul>
  <li>
    str, int, float, long, object, enum
  </li>
</ul>
</div><div class="metadata"><span class="tag">param</span> <span class="arg">name</span><span class="body">name of the signal
</span></div><div class="metadata"><span class="tag">type</span> <span class="arg">name</span><span class="body">string
</span></div><div class="metadata"><span class="tag">param</span> <span class="arg">args</span><span class="body">types for signal parameters, if the first one is a string 'override', the 
signal will be overridden and must therefor exists in the parent GObject.
</span></div><div class="metadata"><span class="tag">note</span> <span class="arg">None</span><span class="body">flags: A combination of;
<ul>
  <li>
    gobject.SIGNAL_RUN_FIRST
  </li>
  <li>
    gobject.SIGNAL_RUN_LAST
  </li>
  <li>
    gobject.SIGNAL_RUN_CLEANUP
  </li>
  <li>
    gobject.SIGNAL_NO_RECURSE
  </li>
  <li>
    gobject.SIGNAL_DETAILED
  </li>
  <li>
    gobject.SIGNAL_ACTION
  </li>
  <li>
    gobject.SIGNAL_NO_HOOKS
  </li>
</ul>
</span></div><div class="metadata"><span class="tag">note</span> <span class="arg">None</span><span class="body">retval: return value in signal callback
</span></div></div>
            </div>
            <div class="function">
            <div class="functionHeader">def <a name="kiwi.utils._max">_max(c):</a></div>
            <div class="functionBody"><div class="undocumented">Undocumented</div></div>
            </div>
            <div class="function">
            <div class="functionHeader">def <a name="kiwi.utils.gproperty">gproperty(name, ptype, default=None, nick='', blurb='', flags=gobject.PARAM_READWRITE, **kwargs):</a></div>
            <div class="functionBody"><div><p>Add a GObject property to the current object.</p>
</div><div class="metadata"><span class="tag">param</span> <span class="arg">name</span><span class="body">name of property
</span></div><div class="metadata"><span class="tag">type</span> <span class="arg">name</span><span class="body">string
</span></div><div class="metadata"><span class="tag">param</span> <span class="arg">ptype</span><span class="body">type of property
</span></div><div class="metadata"><span class="tag">type</span> <span class="arg">ptype</span><span class="body">type
</span></div><div class="metadata"><span class="tag">param</span> <span class="arg">default</span><span class="body">default value
</span></div><div class="metadata"><span class="tag">param</span> <span class="arg">nick</span><span class="body">short description
</span></div><div class="metadata"><span class="tag">param</span> <span class="arg">blurb</span><span class="body">long description
</span></div><div class="metadata"><span class="tag">param</span> <span class="arg">flags</span><span class="body">parameter flags, a combination of:
<ul>
  <li>
    PARAM_READABLE
  </li>
  <li>
    PARAM_READWRITE
  </li>
  <li>
    PARAM_WRITABLE
  </li>
  <li>
    PARAM_CONSTRUCT
  </li>
  <li>
    PARAM_CONSTRUCT_ONLY
  </li>
  <li>
    PARAM_LAX_VALIDATION
  </li>
</ul>
<p>Optional, only for int, float, long types:</p>
</span></div><div class="metadata"><span class="tag">note</span> <span class="arg">None</span><span class="body">minimum: minimum allowed value
</span></div><div class="metadata"><span class="tag">note</span> <span class="arg">None</span><span class="body">maximum: maximum allowed value
</span></div></div>
            </div>
            <div class="function">
            <div class="functionHeader">def <a name="kiwi.utils.quote">quote(msg):</a></div>
            <div class="functionBody"><div><p>Similar to urllib.quote but for glibs GMarkup</p>
</div><div class="metadata"><span class="tag">param</span> <span class="arg">msg</span><span class="body">string to quote
</span></div><div class="metadata"><span class="tag">returns</span> <span class="arg">None</span><span class="body">quoted string
</span></div></div>
            </div></body>

APT Browse - Built by Thomas Orozco.