python-kiwi 1.9.22-2 / usr / share / doc / python-kiwi / api / kiwi.ui.search.SearchContainer.html

This file is indexed.

/usr/share/doc/python-kiwi/api/kiwi.ui.search.SearchContainer.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
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
<!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.ui.search.SearchContainer&rdquo;</title>
        </head>
        <body><h1 class="class">Class k.u.s.SearchContainer(gtk.VBox):</h1><span id="part">Part of <a href="kiwi.ui.search.html">kiwi.ui.search</a></span><div class="toplevel"><div><p>A search container is a widget which consists of:</p>
<ul>
  <li>
    search entry (w/ a label) (<a 
    href="kiwi.ui.search.StringSearchFilter.html">StringSearchFilter</a>)
  </li>
  <li>
    search button
  </li>
  <li>
    objectlist result (SearchResult)
  </li>
  <li>
    a query executer (<a 
    href="kiwi.db.query.QueryExecuter.html">kiwi.db.query.QueryExecuter</a>)
    <p>Additionally you can add a number of search filters to the 
    SearchContainer. You can chose if you want to add the filter in the 
    top-left corner of bottom, see <a 
    href="kiwi.enums.SearchFilterPosition.html">SearchFilterPosition</a></p>
  </li>
</ul>
</div></div><table class="children"><tr class="function"><td>Function</td><td><a href="#kiwi.ui.search.SearchContainer.__init__">__init__</a></td><td><div><p>Create a new SearchContainer object.</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.search.SearchContainer.do_set_property">do_set_property</a></td><td><span class="undocumented">Undocumented</span></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.search.SearchContainer.do_get_property">do_get_property</a></td><td><span class="undocumented">Undocumented</span></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.search.SearchContainer.do_set_child_property">do_set_child_property</a></td><td><span class="undocumented">Undocumented</span></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.search.SearchContainer.do_get_child_property">do_get_child_property</a></td><td><span class="undocumented">Undocumented</span></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.search.SearchContainer.add_filter">add_filter</a></td><td><div><p>Adds a search filter</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.search.SearchContainer.set_filter_position">set_filter_position</a></td><td><div><p>Set the the filter position.</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.search.SearchContainer.get_filter_position">get_filter_position</a></td><td><div><p>Get filter by position.</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.search.SearchContainer.set_query_executer">set_query_executer</a></td><td><div><p>Ties a QueryExecuter instance to the SearchContainer class</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.search.SearchContainer.get_query_executer">get_query_executer</a></td><td><div><p>Fetchs the QueryExecuter for the SearchContainer</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.search.SearchContainer.get_primary_filter">get_primary_filter</a></td><td><div><p>Fetches the primary filter for the SearchContainer.</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.search.SearchContainer.search">search</a></td><td><div><p>Starts a search.</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.search.SearchContainer.set_auto_search">set_auto_search</a></td><td><div><p>Enables/Disables auto search which means that the search result box</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.search.SearchContainer.set_text_field_columns">set_text_field_columns</a></td><td><span class="undocumented">Undocumented</span></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.search.SearchContainer.disable_search_entry">disable_search_entry</a></td><td><div><p>Disables the search entry</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.search.SearchContainer.set_summary_label">set_summary_label</a></td><td><div><p>Adds a summary label to the result set</p>
</div></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.search.SearchContainer._on_search_button__clicked">_on_search_button__clicked</a></td><td><span class="undocumented">Undocumented</span></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.search.SearchContainer._on_search_entry__activate">_on_search_entry__activate</a></td><td><span class="undocumented">Undocumented</span></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.search.SearchContainer._on_search_filter__changed">_on_search_filter__changed</a></td><td><span class="undocumented">Undocumented</span></td></tr><tr class="function"><td>Function</td><td><a href="#kiwi.ui.search.SearchContainer._create_ui">_create_ui</a></td><td><span class="undocumented">Undocumented</span></td></tr></table>
            <div class="function">
            <div class="functionHeader">def <a name="kiwi.ui.search.SearchContainer.__init__">__init__(self, columns=None, chars=25):</a></div>
            <div class="functionBody"><div><p>Create a new SearchContainer object.</p>
</div><div class="metadata"><span class="tag">param</span> <span class="arg">columns</span><span class="body">a list of <a 
href="kiwi.ui.objectlist.Column.html">kiwi.ui.objectlist.Column</a>
</span></div><div class="metadata"><span class="tag">param</span> <span class="arg">chars</span><span class="body">maximum number of chars used by the search entry
</span></div></div>
            </div>
            <div class="function">
            <div class="functionHeader">def <a name="kiwi.ui.search.SearchContainer.do_set_property">do_set_property(self, pspec, value):</a></div>
            <div class="functionBody"><div class="undocumented">Undocumented</div></div>
            </div>
            <div class="function">
            <div class="functionHeader">def <a name="kiwi.ui.search.SearchContainer.do_get_property">do_get_property(self, pspec):</a></div>
            <div class="functionBody"><div class="undocumented">Undocumented</div></div>
            </div>
            <div class="function">
            <div class="functionHeader">def <a name="kiwi.ui.search.SearchContainer.do_set_child_property">do_set_child_property(self, child, property_id, value, pspec):</a></div>
            <div class="functionBody"><div class="undocumented">Undocumented</div></div>
            </div>
            <div class="function">
            <div class="functionHeader">def <a name="kiwi.ui.search.SearchContainer.do_get_child_property">do_get_child_property(self, child, property_id, pspec):</a></div>
            <div class="functionBody"><div class="undocumented">Undocumented</div></div>
            </div>
            <div class="function">
            <div class="functionHeader">def <a name="kiwi.ui.search.SearchContainer.add_filter">add_filter(self, search_filter, position=SearchFilterPosition.BOTTOM, columns=None, callback=None):</a></div>
            <div class="functionBody"><div><p>Adds a search filter</p>
</div><div class="metadata"><span class="tag">param</span> <span class="arg">search_filter</span><span class="body">the search filter
</span></div><div class="metadata"><span class="tag">param</span> <span class="arg">postition</span><span class="body">a <a href="kiwi.enums.SearchFilterPosition.html">SearchFilterPosition</a> 
enum
</span></div><div class="metadata"><span class="tag">param</span> <span class="arg">columns</span><span class="body"></span></div><div class="metadata"><span class="tag">param</span> <span class="arg">callback</span><span class="body"></span></div></div>
            </div>
            <div class="function">
            <div class="functionHeader">def <a name="kiwi.ui.search.SearchContainer.set_filter_position">set_filter_position(self, search_filter, position):</a></div>
            <div class="functionBody"><div><p>Set the the filter position.</p>
</div><div class="metadata"><span class="tag">param</span> <span class="arg">search_filter</span><span class="body"></span></div><div class="metadata"><span class="tag">param</span> <span class="arg">position</span><span class="body"></span></div></div>
            </div>
            <div class="function">
            <div class="functionHeader">def <a name="kiwi.ui.search.SearchContainer.get_filter_position">get_filter_position(self, search_filter):</a></div>
            <div class="functionBody"><div><p>Get filter by position.</p>
</div><div class="metadata"><span class="tag">param</span> <span class="arg">search_filter</span><span class="body"></span></div></div>
            </div>
            <div class="function">
            <div class="functionHeader">def <a name="kiwi.ui.search.SearchContainer.set_query_executer">set_query_executer(self, querty_executer):</a></div>
            <div class="functionBody"><div><p>Ties a QueryExecuter instance to the SearchContainer class</p>
</div><div class="metadata"><span class="tag">param</span> <span class="arg">querty_executer</span><span class="body">a querty executer
</span></div><div class="metadata"><span class="tag">type</span> <span class="arg">querty_executer</span><span class="body">a <a href="kiwi.db.query.QueryExecuter.html">QueryExecuter</a> subclass
</span></div></div>
            </div>
            <div class="function">
            <div class="functionHeader">def <a name="kiwi.ui.search.SearchContainer.get_query_executer">get_query_executer(self):</a></div>
            <div class="functionBody"><div><p>Fetchs the QueryExecuter for the SearchContainer</p>
</div><div class="metadata"><span class="tag">returns</span> <span class="arg">None</span><span class="body">a querty executer
</span></div><div class="metadata"><span class="tag">rtype</span> <span class="arg">None</span><span class="body">a <a href="kiwi.db.query.QueryExecuter.html">QueryExecuter</a> subclass
</span></div></div>
            </div>
            <div class="function">
            <div class="functionHeader">def <a name="kiwi.ui.search.SearchContainer.get_primary_filter">get_primary_filter(self):</a></div>
            <div class="functionBody"><div><p>Fetches the primary filter for the SearchContainer. The primary filter 
is the filter attached to the standard entry normally used to do free text 
searching</p>
</div><div class="metadata"><span class="tag">returns</span> <span class="arg">None</span><span class="body">the primary filter
</span></div></div>
            </div>
            <div class="function">
            <div class="functionHeader">def <a name="kiwi.ui.search.SearchContainer.search">search(self):</a></div>
            <div class="functionBody"><div><p>Starts a search. Fetches the states of all filters and send it to a 
query executer and finally puts the result in the result class</p>
</div></div>
            </div>
            <div class="function">
            <div class="functionHeader">def <a name="kiwi.ui.search.SearchContainer.set_auto_search">set_auto_search(self, auto_search):</a></div>
            <div class="functionBody"><div><p>Enables/Disables auto search which means that the search result box is 
automatically populated when a filter changes</p>
</div><div class="metadata"><span class="tag">param</span> <span class="arg">auto_search</span><span class="body">True to enable, False to disable
</span></div></div>
            </div>
            <div class="function">
            <div class="functionHeader">def <a name="kiwi.ui.search.SearchContainer.set_text_field_columns">set_text_field_columns(self, columns):</a></div>
            <div class="functionBody"><div class="undocumented">Undocumented</div></div>
            </div>
            <div class="function">
            <div class="functionHeader">def <a name="kiwi.ui.search.SearchContainer.disable_search_entry">disable_search_entry(self):</a></div>
            <div class="functionBody"><div><p>Disables the search entry</p>
</div></div>
            </div>
            <div class="function">
            <div class="functionHeader">def <a name="kiwi.ui.search.SearchContainer.set_summary_label">set_summary_label(self, column, label='Total:', format='%s'):</a></div>
            <div class="functionBody"><div><p>Adds a summary label to the result set</p>
</div><div class="metadata"><span class="tag">param</span> <span class="arg">column</span><span class="body">the column to sum from
</span></div><div class="metadata"><span class="tag">param</span> <span class="arg">label</span><span class="body">the label to use, defaults to 'Total:'
</span></div><div class="metadata"><span class="tag">param</span> <span class="arg">format</span><span class="body">the format, defaults to '%%s', must include '%%s'
</span></div></div>
            </div>
            <div class="function">
            <div class="functionHeader">def <a name="kiwi.ui.search.SearchContainer._on_search_button__clicked">_on_search_button__clicked(self, button):</a></div>
            <div class="functionBody"><div class="undocumented">Undocumented</div></div>
            </div>
            <div class="function">
            <div class="functionHeader">def <a name="kiwi.ui.search.SearchContainer._on_search_entry__activate">_on_search_entry__activate(self, button):</a></div>
            <div class="functionBody"><div class="undocumented">Undocumented</div></div>
            </div>
            <div class="function">
            <div class="functionHeader">def <a name="kiwi.ui.search.SearchContainer._on_search_filter__changed">_on_search_filter__changed(self, search_filter):</a></div>
            <div class="functionBody"><div class="undocumented">Undocumented</div></div>
            </div>
            <div class="function">
            <div class="functionHeader">def <a name="kiwi.ui.search.SearchContainer._create_ui">_create_ui(self):</a></div>
            <div class="functionBody"><div class="undocumented">Undocumented</div></div>
            </div></body>

APT Browse - Built by Thomas Orozco.