Home       Trees       Index       Help   

Yagdoc

Package yagdoc :: Module inspector :: Class Type
[show private | hide private]
[frames | no frames]

Type Type

object --+
         |
        Type

Representation of the inspected information about one GType.

All instance variables always exist, even if they do not make sense for a particular type.
Method Summary
  __init__(self, name)
Create a new Type.
  add_binding(self, record)
Add a binding from a Bindings record.
  add_property(self, record, ptype)
Add a property from a Properties or special properties record.
  add_signal(self, record)
Add a signal from a Signals record.
  set_children(self, record)
Set children from a Children record.
  set_flags(self, record)
Set flags from a Flags record.
  set_interfaces(self, record)
Set implemented interfaces from a Interfaces record.
  set_prerequsites(self, record)
Set interface prerequisites from a Prerequisites record.
  set_type_func(self, record)
Set get-type function from a Types record.
  update_parentage(self, types)
Set the parent of all children types to own name.
Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Instance Variable Summary
list of Binding bindings: Default keyboard bindings (useful only for GtkWidget subclasses).
list of str children: Names of types derived from this type.
int flags: Object flags (combination of FUNDAMENTAL, DERIVABLE, DEEP_DERIVABLE, INSTANTIABLE, INTERFACE, ABSTRACT, CLASSED, HAS_VALUE_TABLE, IS_VALUE_TYPE flag bits).
list of str interfaces: Names of interfaces this type implementes (useful only for derivable non-interface types).
str name: Type name.
str or None parent: Name of parent type, None if type is fundamental.
list of str prerequisites: Names of interface implementation prerequisites (useful only for interface types).
list of Property properties: Properties this type registered.
list of Signal signals: Signals this type registered.
dict of list of Property sproperties: Special properties this type registered.
str or None type_func: Name of the get-type function.

Class Variable Summary
int FUNDAMENTAL = 1                                                                     
int DERIVABLE = 2                                                                     
int DEEP_DERIVABLE = 4                                                                     
int INSTANTIABLE = 8                                                                     
int INTERFACE = 16                                                                    
int ABSTRACT = 32                                                                    
int CLASSED = 64                                                                    
int HAS_VALUE_TABLE = 128                                                                   
int IS_VALUE_TYPE = 256                                                                   
dict flag_values = {'a': 32, 'c': 64, 'd': 2, 'f': 1, 'i': 8,...

Method Details

__init__(self, name)
(Constructor)

Create a new Type.
Parameters:
name - Type name, e.g. 'GtkTreeModel'.
           (type=str)
Overrides:
__builtin__.object.__init__

add_binding(self, record)

Add a binding from a Bindings record.
Parameters:
record - Record to parse (without the type name).
           (type=str)

add_property(self, record, ptype=None)

Add a property from a Properties or special properties record.
Parameters:
record - Record to parse (without the type name).
           (type=str)
ptype - Special property type. If None or unspecified, normal property is added.
           (type=str or None)

add_signal(self, record)

Add a signal from a Signals record.
Parameters:
record - Record to parse (without the type name).
           (type=str)

set_children(self, record)

Set children from a Children record.
Parameters:
record - Record to parse (without the type name).
           (type=str)

set_flags(self, record)

Set flags from a Flags record.
Parameters:
record - Record to parse (without the type name).
           (type=str)

set_interfaces(self, record)

Set implemented interfaces from a Interfaces record.
Parameters:
record - Record to parse (without the type name).
           (type=str)

set_prerequsites(self, record)

Set interface prerequisites from a Prerequisites record.
Parameters:
record - Record to parse (without the type name).
           (type=str)

set_type_func(self, record)

Set get-type function from a Types record.
Parameters:
record - Record to parse (without the type name).
           (type=str)

update_parentage(self, types)

Set the parent of all children types to own name.
Parameters:
types - Map from type names to Types.
           (type=dict)

Instance Variable Details

bindings

Default keyboard bindings (useful only for GtkWidget subclasses).
Type:
list of Binding

children

Names of types derived from this type.
Type:
list of str

flags

Object flags (combination of FUNDAMENTAL, DERIVABLE, DEEP_DERIVABLE, INSTANTIABLE, INTERFACE, ABSTRACT, CLASSED, HAS_VALUE_TABLE, IS_VALUE_TYPE flag bits).
Type:
int

interfaces

Names of interfaces this type implementes (useful only for derivable non-interface types).
Type:
list of str

name

Type name. For instance 'GtkTreeModel'.
Type:
str

parent

Name of parent type, None if type is fundamental. This attribute is set by update_parentage.
Type:
str or None

prerequisites

Names of interface implementation prerequisites (useful only for interface types).
Type:
list of str

properties

Properties this type registered.
Type:
list of Property

signals

Signals this type registered.
Type:
list of Signal

sproperties

Special properties this type registered. The keys of the dictionary are the special property types, e.g. 'Child' or 'Style'. Particular lists exists only for special property types this type actually registered.
Type:
dict of list of Property

type_func

Name of the get-type function. For instance 'gtk_tree_model_get_type'. Only for explictly inspected types; set to None for types discovered by inspection.
Type:
str or None

Class Variable Details

FUNDAMENTAL

Type:
int
Value:
1                                                                     

DERIVABLE

Type:
int
Value:
2                                                                     

DEEP_DERIVABLE

Type:
int
Value:
4                                                                     

INSTANTIABLE

Type:
int
Value:
8                                                                     

INTERFACE

Type:
int
Value:
16                                                                    

ABSTRACT

Type:
int
Value:
32                                                                    

CLASSED

Type:
int
Value:
64                                                                    

HAS_VALUE_TABLE

Type:
int
Value:
128                                                                   

IS_VALUE_TYPE

Type:
int
Value:
256                                                                   

flag_values

Type:
dict
Value:
{'D': 4, 'V': 256, 'a': 32, 'c': 64, 'd': 2, 'f': 1, 'i': 8, 'n': 16, \
'v': 128}

   Home       Trees       Index       Help   

Yagdoc

Generated by Epydoc 2.1 on Fri Oct 5 00:36:53 2007 http://epydoc.sf.net