Home       Trees       Index       Help   

Yagdoc

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

Type Property

object --+
         |
        Property

Representation of the inspected information about one GObject property.
Method Summary
  __init__(self, name, flags, ptype, blurb, default, constraints)
Create a new Property.
  parse(self, record)
Parse one Properties and special properties section record.
Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Instance Variable Summary
str blurb: Blurb text.
str or None constraints: Value constraints.
str or None default: Default value.
int flags: Signal flags (combination of READ, WRITE, CONSTRUCTION, CONSTRUCTION_ONLY, flag bits).
str name: Property name (with underscores, not dashes).
str type: Value type name.

Class Variable Summary
int READ = 1                                                                     
int WRITE = 2                                                                     
int CONSTRUCTION = 4                                                                     
int CONSTRUCTION_ONLY = 8                                                                     
dict flag_values = {'c': 4, 'r': 1, 'C': 8, 'w': 2}

Method Details

__init__(self, name='', flags=0, ptype='', blurb='', default=None, constraints=None)
(Constructor)

Create a new Property.
Overrides:
__builtin__.object.__init__

parse(self, record)

Parse one Properties and special properties section record.
Parameters:
record - Record to parse (without the type name).
           (type=str)

Instance Variable Details

blurb

Blurb text.
Type:
str

constraints

Value constraints.
Type:
str or None

default

Default value.
Type:
str or None

flags

Signal flags (combination of READ, WRITE, CONSTRUCTION, CONSTRUCTION_ONLY, flag bits).
Type:
int

name

Property name (with underscores, not dashes).
Type:
str

type

Value type name.
Type:
str

Class Variable Details

READ

Type:
int
Value:
1                                                                     

WRITE

Type:
int
Value:
2                                                                     

CONSTRUCTION

Type:
int
Value:
4                                                                     

CONSTRUCTION_ONLY

Type:
int
Value:
8                                                                     

flag_values

Type:
dict
Value:
{'c': 4, 'r': 1, 'C': 8, 'w': 2}

   Home       Trees       Index       Help   

Yagdoc

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