Package pyscript :: Module groups :: Class Page
[show private | hide private]
[frames | no frames]

Class Page

object --+                
         |                
     PsObj --+            
             |            
     AffineObj --+        
                 |        
              Area --+    
                     |    
                 Group --+
                         |
                        Page

Known Subclasses:
EmptySlide, Poster, Poster, Poster_1, Slide

A postscript page
Method Summary
Area area(self)
return an area object same size as page in default units
  bbox(self)
Return the bounding box of the Page object as a Bbox object
  bbox_pp(self)
Return the bounding box of the Page object
  bbox_pp_raw(self)
Return the raw string of the bounding box of the Page object
  recalc_size(self)
Recalculate the size of the Page object
  write(self, fp, number)
write a self-contained PS Page
    Inherited from Group
  __init__(self, *objects, **options)
Initialisation of Group object
  __getitem__(self, i)
Get an item from the list of objects
  __getslice__(self, i, j)
Get a slice of items from the list of objects
  __len__(self)
Returns the length of the object list
  append(self, *objs, **options)
append object(s) to group
self apply(self, **options)
apply attributes to all objects
  body(self)
Returns the body postscript of the object
  clear(self)
Clear all the elements and reset group to an empty group
  insert(self, idx, obj)
insert object
  reverse(self)
Reverse the order of objects in the list of objects in the group
  validate(self, obj)
make sure this object can be inserted into group
    Inherited from Area
  _get_c(self)
Get the "centre" point
  _get_e(self)
Get the "east" point
  _get_n(self)
Get the "north" point
  _get_ne(self)
Get the "north-east" point
  _get_nw(self)
Get the "north-west" point
  _get_s(self)
Get the "south" point
  _get_se(self)
Get the "south-east" point
  _get_sw(self)
Get the "south-west" point
  _get_w(self)
Get the "west" point
  _set_c(self, pe)
Set the "centre" point
  _set_e(self, pe)
Set the "east" point
  _set_n(self, pe)
Set the "north" point
  _set_ne(self, pe)
Set the "north-east" point
  _set_nw(self, pe)
Set the "north-west" point
  _set_s(self, pe)
Set the "south" point
  _set_se(self, pe)
Set the "south-east" point
  _set_sw(self, pe)
Set the "south-west" point
  _set_w(self, pe)
Set the "west" point
    Inherited from AffineObj
self concat(self, t, p)
concat matrix t to tranformation matrix
P etoi(self, p_e)
convert external to internal co-ords
P itoe(self, p_i)
convert internal to external co-ords
self move(self, *args)
translate object by a certain amount
string postbody(self)
undo coordinate system transformation
string prebody(self)
set up transformation of coordinate system
self reflect(self, angle, p)
reflect object in mirror
self rotate(self, angle, p)
rotate object, the rotation is around p when supplied otherwise it's the objects origin
self scale(self, sx, sy, p)
scale object size (towards objects origin or p)
self shear(self, s, angle, p)
shear object
    Inherited from PsObj
self __call__(self, **options)
Set a whole lot of attributes in one go
string __repr__(self)
Return a representation of this object
string __str__(self)
return actual postscript string to generate object
self copy(self, **options)
return a copy of this object with listed attributes modified
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
    Inherited from type
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T

Property Summary
    Inherited from Area
  c
  e
  n
  ne
  nw
  s
  se
  sw
  w

Class Variable Summary
NoneType label: page number label
str orientation: The paper orientation, "Portrait"/"Landscape"
dict PAPERSIZES = {'letter': (612, 792), 'b4': (709, 1002), '...
str size: The paper size, eg "a4"
    Inherited from Area
  c = pyscript.objects.Area.c
int height: the height
P isw = <class 'pyscript.vectors.P'>
int width: the width
    Inherited from AffineObj
P o = <class 'pyscript.vectors.P'>
Matrix T = <pyscript.vectors.Matrix instance at 0x40449cec>

Method Details

area(self)

return an area object same size as page in default units
Returns:
Area

bbox(self)

Return the bounding box of the Page object as a Bbox object
Overrides:
pyscript.groups.Group.bbox

bbox_pp(self)

Return the bounding box of the Page object

bbox_pp_raw(self)

Return the raw string of the bounding box of the Page object

recalc_size(self)

Recalculate the size of the Page object
Overrides:
pyscript.groups.Group.recalc_size

write(self, fp, number)

write a self-contained PS Page
Parameters:
fp - the filehandle to write the postscript to
           (type=filehandle object)
number - the number of the page to write
           (type=int)

Class Variable Details

label

page number label
Type:
NoneType
Value:
None                                                                  

orientation

The paper orientation, "Portrait"/"Landscape"
Type:
str
Value:
'Portrait'                                                             

PAPERSIZES

Type:
dict
Value:
{'11x17': (792, 1224),
 'a0': (2380, 3368),
 'a1': (1684, 2380),
 'a10': (74, 105),
 'a2': (1190, 1684),
 'a3': (842, 1190),
 'a4': (595, 842),
 'a5': (421, 595),
...                                                                    

size

The paper size, eg "a4"
Type:
str
Value:
'a4'                                                                   

Generated by Epydoc 2.0 on Mon Apr 24 17:02:37 2006 http://epydoc.sf.net