widgets Package

widgets Package

button Module

GtkButton support for the Kiwi Framework

class kiwi.ui.widgets.button.ProxyButton

Bases: gtk.Button, kiwi.ui.proxywidget.ProxyWidgetMixin

A ProxyButton is a Button subclass which is implementing the features required to be used inside the kiwi framework.

It has a specific feature not found in other implementations. If the datatype is set to pixbuf a gtk.Image will be constructed from the pixbuf and be set as a child for the Button

allowed_data_types = (<type 'basestring'>, <type 'datetime.date'>, <type 'datetime.datetime'>, <type 'datetime.time'>, <type 'gtk.gdk.Pixbuf'>, <type 'int'>, <type 'float'>, <type 'long'>, <class 'decimal.Decimal'>)

data_type

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

do_get_property(pspec)

do_set_property(pspec, value)

model_attribute

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

read()

update(data)

checkbutton Module

GtkCheckButton support for the Kiwi Framework

class kiwi.ui.widgets.checkbutton.CheckButton

Bases: kiwi.ui.widgets.checkbutton.ProxyCheckButton

class kiwi.ui.widgets.checkbutton.ProxyCheckButton(label=None, use_underline=True)

Bases: gtk.CheckButton, kiwi.ui.proxywidget.ProxyWidgetMixin

allowed_data_types = (<type 'bool'>,)

data_type

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

do_get_property(pspec)

do_set_property(pspec, value)

do_toggled()

model_attribute

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

read()

update(data)

colorbutton Module

ColorButton proxy for the kiwi framework

class kiwi.ui.widgets.colorbutton.ProxyColorButton(color=gtk.gdk.Color('#000'))

Bases: gtk.ColorButton, kiwi.ui.proxywidget.ProxyWidgetMixin

allowed_data_types = (<type 'str'>,)

data_type

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

do_color_set()

do_get_property(pspec)

do_set_property(pspec, value)

model_attribute

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

read()

update(data)

combo Module

GtkComboBox and GtkComboBoxEntry support for the Kiwi Framework.

The GtkComboBox and GtkComboBoxEntry classes here are also slightly extended they contain methods to easily insert and retrieve data from combos.

class kiwi.ui.widgets.combo.ProxyComboBox

Bases: gtk.ComboBox, kiwi.ui.proxywidget.ProxyWidgetMixin

allowed_data_types = (<type 'basestring'>, <type 'object'>, <type 'int'>, <type 'float'>, <type 'long'>, <class 'decimal.Decimal'>)

append_item(label, data=None)

See kiwi.interfaces.IEasyCombo.append_item

clear()

See kiwi.interfaces.IEasyCombo.clear

color_attribute

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

data_type

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

do_get_property(pspec)

do_set_property(pspec, value)

get_color_attribute()

get_model_items()

See kiwi.interfaces.IEasyCombo.get_model_strings

get_model_strings()

See kiwi.interfaces.IEasyCombo.select_item_by_data

get_selected()

See kiwi.interfaces.IEasyCombo.get_selected_data

get_selected_data()

See kiwi.interfaces.IEasyCombo.get_selected_label

get_selected_label()

See kiwi.interfaces.IEasyCombo.get_model_items

insert_item(position, label, data=None)

See kiwi.interfaces.IEasyCombo.insert_item

model_attribute

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

prefill(itemdata, sort=False)

See kiwi.interfaces.IEasyCombo.prefill

read()

select(data)

See kiwi.interfaces.IEasyCombo.select

select_item_by_data(data)

See kiwi.interfaces.IEasyCombo.select_item_by_label

select_item_by_label(label)

See kiwi.interfaces.IEasyCombo.select_item_by_position

select_item_by_position(pos)

See kiwi.interfaces.IEasyCombo.select

set_color_attribute(value)

update(data)

class kiwi.ui.widgets.combo.ProxyComboBoxEntry(**kwargs)

Bases: kiwi.ui.comboboxentry.BaseComboBoxEntry, kiwi.ui.proxywidget.ValidatableProxyWidgetMixin

allowed_data_types = (<type 'basestring'>, <type 'object'>, <type 'int'>, <type 'float'>, <type 'long'>, <class 'decimal.Decimal'>)

append_item(label, data=None)

See kiwi.interfaces.IEasyCombo.append_item

clear()

See kiwi.interfaces.IEasyCombo.clear

data_type

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

do_get_property(pspec)

do_set_property(pspec, value)

get_model_items()

See kiwi.interfaces.IEasyCombo.get_model_strings

get_model_strings()

See kiwi.interfaces.IEasyCombo.select_item_by_data

get_selected()

See kiwi.interfaces.IEasyCombo.get_selected_data

get_selected_data()

See kiwi.interfaces.IEasyCombo.get_selected_label

get_selected_label()

See kiwi.interfaces.IEasyCombo.get_model_items

insert_item(position, label, data=None)

See kiwi.interfaces.IEasyCombo.insert_item

list_editable

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

mandatory

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

model_attribute

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

prefill(itemdata, sort=False, clear_entry=True)

See kiwi.interfaces.IEasyCombo.prefill

read()

select(data)

See kiwi.interfaces.IEasyCombo.select

select_item_by_data(data)

See kiwi.interfaces.IEasyCombo.select_item_by_label

select_item_by_label(label)

See kiwi.interfaces.IEasyCombo.select_item_by_position

select_item_by_position(pos)

See kiwi.interfaces.IEasyCombo.select

set_mode(mode)

update(data)

class kiwi.ui.widgets.combo.ProxyComboEntry

Bases: kiwi.ui.comboentry.ComboEntry, kiwi.ui.proxywidget.ValidatableProxyWidgetMixin

allowed_data_types = (<type 'basestring'>, <type 'object'>, <type 'int'>, <type 'float'>, <type 'long'>, <class 'decimal.Decimal'>)

data_type

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

do_get_property(pspec)

do_set_property(pspec, value)

get_selected_data()

list_editable

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

mandatory

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

model_attribute

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

read()

set_tooltip(text)

update(data)

combobox Module

GtkComboBox and GtkComboBoxEntry support for the Kiwi Framework. backwards compatibility layer

class kiwi.ui.widgets.combobox.ComboBox

Bases: kiwi.ui.widgets.combo.ProxyComboBox

class kiwi.ui.widgets.combobox.ComboBoxEntry(**kwargs)

Bases: kiwi.ui.widgets.combo.ProxyComboBoxEntry

contextmenu Module

class kiwi.ui.widgets.contextmenu.ContextMenu

Bases: gtk.Menu

append_separator()

popup(button, time)

class kiwi.ui.widgets.contextmenu.ContextMenuItem(label, stock=None)

Bases: gtk.ImageMenuItem

entry Module

GtkEntry support for the Kiwi Framework

class kiwi.ui.widgets.entry.Entry(data_type=None)

Bases: kiwi.ui.widgets.entry.ProxyEntry

class kiwi.ui.widgets.entry.ProxyDateEntry

Bases: kiwi.ui.dateentry.DateEntry, kiwi.ui.proxywidget.ValidatableProxyWidgetMixin

allowed_data_types = (<type 'datetime.date'>,)

data_type

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

do_changed()

do_get_property(pspec)

do_set_property(pspec, value)

get_background()

mandatory

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

model_attribute

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

read()

set_blank()

set_invalid(text=None, fade=True)

set_valid()

update(data)

class kiwi.ui.widgets.entry.ProxyEntry(data_type=None)

Bases: kiwi.ui.entry.KiwiEntry, kiwi.ui.proxywidget.ValidatableProxyWidgetMixin

The Kiwi Entry widget has many special features that extend the basic gtk entry.

First of all, as every Kiwi Widget, it implements the Proxy protocol. As the users types the entry can interact with the application model automatically. Kiwi Entry also implements interesting UI additions. If the input data does not match the data type of the entry the background nicely fades to a light red color. As the background changes an information icon appears. When the user passes the mouse over the information icon a tooltip is displayed informing the user how to correctly fill the entry. When dealing with date and float data-type the information on how to fill these entries is displayed according to the current locale.

allowed_data_types = (<type 'basestring'>, <type 'datetime.date'>, <type 'datetime.time'>, <type 'datetime.datetime'>, <type 'object'>, <type 'int'>, <type 'float'>, <type 'long'>, <class 'decimal.Decimal'>)

data_type

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

do_changed()

do_get_property(pspec)

do_set_property(pspec, value)

mandatory

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

model_attribute

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

read()

set_completion_strings(*args, **kwargs)

set_mask_for_data_type(data_type)

Set a mask for the parameter data_type. :param data_type:

set_text(text)

Sets the text of the entry

Parameters:text –

update(data)

class kiwi.ui.widgets.entry.ProxyEntryMeta(name, bases, dict_)

Bases: gobject.GObjectMeta

filechooser Module

Filechooser widgets for the kiwi framework

class kiwi.ui.widgets.filechooser.ProxyFileChooserButton(title=None, backend=None, dialog=None)

Bases: kiwi.ui.widgets.filechooser._FileChooserMixin, gtk.FileChooserButton, kiwi.ui.proxywidget.ProxyWidgetMixin

class kiwi.ui.widgets.filechooser.ProxyFileChooserWidget(action=<enum GTK_FILE_CHOOSER_ACTION_OPEN of type GtkFileChooserAction>, backend=None)

Bases: kiwi.ui.widgets.filechooser._FileChooserMixin, gtk.FileChooserWidget, kiwi.ui.proxywidget.ProxyWidgetMixin

fontbutton Module

FontButton proxy for the kiwi framework

class kiwi.ui.widgets.fontbutton.ProxyFontButton(fontname=None)

Bases: gtk.FontButton, kiwi.ui.proxywidget.ProxyWidgetMixin

allowed_data_types = (<type 'basestring'>,)

do_font_set()

read()

update(data)

label Module

GtkLabel support for the Kiwi Framework

The Label is also extended to support some basic markup like Label.set_bold

class kiwi.ui.widgets.label.Label(label='', data_type=None)

Bases: kiwi.ui.widgets.label.ProxyLabel

class kiwi.ui.widgets.label.ProxyLabel(label='', data_type=None)

Bases: gtk.Label, kiwi.ui.proxywidget.ProxyWidgetMixin

allowed_data_types = (<type 'basestring'>, <type 'datetime.date'>, <type 'datetime.datetime'>, <type 'datetime.time'>, <type 'int'>, <type 'float'>, <type 'long'>, <class 'decimal.Decimal'>)

data_type

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

do_get_property(pspec)

do_set_property(pspec, value)

model_attribute

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

read()

classmethod replace(markup, value)

set_bold(value)

If True set the text to bold. False sets the text to normal

set_color(color)

set_italic(value)

Enable or disable italic text :param value: Allowed values: - True: enable Italic attribute - False: disable Italic attribute

set_size(size=None)

Set the size of the label. If size is empty the label will be set to the default size. :param size: Allowed values:

• xx-small
• x-small
• small
• medium,
• large
• x-large
• xx-large

set_text(text)

Overrides gtk.Label set_text method. Sets the new text of the label but keeps the formating :param text: label :type text: string

set_underline(value)

Enable or disable underlined text :param value: Allowed values: - True: enable Underline attribute - Fase: disable Underline attribute

update(data)

list Module

High level wrapper for GtkTreeView: backwards compatibility layer

class kiwi.ui.widgets.list.List(columns=[], instance_list=None, mode=<enum GTK_SELECTION_BROWSE of type GtkSelectionMode>)

Bases: kiwi.ui.objectlist.ObjectList

add_instance(*args, **kwargs)

remove_instance(*args, **kwargs)

select_instance(*args, **kwargs)

update_instance(*args, **kwargs)

radiobutton Module

GtkRadioButton support for the Kiwi Framework

class kiwi.ui.widgets.radiobutton.ProxyRadioButton(group=None, label=None, use_underline=True)

Bases: gtk.RadioButton, kiwi.ui.proxywidget.ProxyWidgetMixin

allowed_data_types = (<type 'object'>,)

data_type

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

data_value

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

do_get_property(pspec)

do_set_property(pspec, value)

get_selected()

Get the currently selected radiobutton.

Returns:The selected RadioButton or None if there are no selected radiobuttons.

model_attribute

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

read()

update(data)

class kiwi.ui.widgets.radiobutton.RadioButton

Bases: kiwi.ui.widgets.radiobutton.ProxyRadioButton

scale Module

GtkHScale and GtkVScale support for the Kiwi Framework

class kiwi.ui.widgets.scale.ProxyHScale

Bases: kiwi.ui.widgets.scale._ProxyScale, kiwi.ui.proxywidget.ProxyWidgetMixin, gtk.HScale

data_type

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

do_get_property(pspec)

do_set_property(pspec, value)

model_attribute

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

class kiwi.ui.widgets.scale.ProxyVScale

Bases: kiwi.ui.widgets.scale._ProxyScale, kiwi.ui.proxywidget.ProxyWidgetMixin, gtk.VScale

data_type

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

do_get_property(pspec)

do_set_property(pspec, value)

model_attribute

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

spinbutton Module

GtkSpinButton support for the Kiwi Framework

class kiwi.ui.widgets.spinbutton.ProxySpinButton(data_type=<type 'int'>)

Bases: gtk.SpinButton, kiwi.ui.proxywidget.ValidatableProxyWidgetMixin

A SpinButton subclass which adds supports for the Kiwi Framework. This widget supports validation The only allowed types for spinbutton are int and float.

allowed_data_types = (<type 'int'>, <type 'float'>, <type 'long'>, <class 'decimal.Decimal'>)

data_type

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

do_changed()

Called when the content of the spinbutton changes.

do_get_property(pspec)

do_set_property(pspec, value)

get_background()

mandatory

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

model_attribute

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

read()

set_pixbuf(pixbuf)

set_tooltip(text)

update(data)

update_background(color)

class kiwi.ui.widgets.spinbutton.SpinButton

Bases: kiwi.ui.widgets.spinbutton.ProxySpinButton

textview Module

GtkTextView support for the Kiwi Framework

class kiwi.ui.widgets.textview.ProxyTextView

Bases: gtk.TextView, kiwi.ui.proxywidget.ValidatableProxyWidgetMixin

allowed_data_types = (<type 'basestring'>, <type 'datetime.date'>, <type 'int'>, <type 'float'>, <type 'long'>, <class 'decimal.Decimal'>)

data_type

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

data_value

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

do_get_property(pspec)

do_set_property(pspec, value)

mandatory

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

model_attribute

Creates a new property which in conjunction with GObject subclass will create a property proxy:

>>> class MyObject(gobject.GObject):
>>> ... prop = gobject.property(type=str)

>>> obj = MyObject()
>>> obj.prop = 'value'

>>> obj.prop
'value'

The API is similar to the builtin property:

class AnotherObject(gobject.GObject):

@gobject.property def prop(self):

return ...

Which will create a read-only property called prop.

read()

update(data)

class kiwi.ui.widgets.textview.TextView

Bases: kiwi.ui.widgets.textview.ProxyTextView