Package pyscript :: Package lib :: Module presentation :: Class Poster
[show private | hide private]
[frames | no frames]

Class Poster

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


A poster class.

More docs forthcoming...
Method Summary
  __init__(self, size, style)
  add_column(self, column, side)
Add a column of the poster.
  add_logo(self, logo, height)
Add a logo to the poster.
  add_logos(self, *logos, **options)
Add several logos to the poster at one time.
  make(self, file)
Make the poster.
  set_abstract(self, abstract)
Set the abstract of the poster
  set_address(self, address)
Set the address of the institution of those presenting the poster
  set_authors(self, authors)
Set the authors of the poster
  set_num_columns(self, num_columns)
Set the number of columns to use for the poster.
  set_orientation(self, orientation)
Set the orientation of the poster.
  set_size(self, size)
Set the size of the poster.
  set_style(self, style)
Set the style of the poster.
  set_title(self, title)
Set the title to use for the poster
  _make_abstract(self)
Make the abstract
  _make_address(self)
Make the address
  _make_authors(self)
Make the authors
  _make_background(self)
Make the background of the poster
  _make_columns(self)
Make the columns
  _make_logos(self)
Make the logos
  _make_title(self)
Make the title
  _read_style(self, styleFname)
Read the talk style file
    Inherited from Page
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
  __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
    Inherited from Page
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

add_column(self, column, side)

Add a column of the poster.
Parameters:
column - the Column object to add as the poster column
           (type=Column object)
side - the side on which the column is to be on the poster. Valid values are "left", "middle" (useful for landscape only) and "right".
           (type=string)

add_logo(self, logo, height=None)

Add a logo to the poster.

If only one logo is added to the poster, it is by default located at the top left-hand corner. The second logo is then positioned in the top right-hand corner. The third is positioned in the top middle. If you add more than that, the logos are distributed evenly across the top of the poster.
Parameters:
logo - the file name of the eps file of the logo to add
           (type=text)
height - the height of the logo
           (type=float)

add_logos(self, *logos, **options)

Add several logos to the poster at one time.

If only one logo is added to the poster, it is by default located at the top left-hand corner. The second logo is then positioned in the top right-hand corner. The third is positioned in the top middle. If you add more than that, the logos are distributed evenly across the top of the poster.
Parameters:
logos - list of file names of the eps files of the logos to add
           (type=list of strings)
Keyword Parameters:
height - the height of the logo
           (type=float)

make(self, file)

Make the poster.
Parameters:
file - the file name of the poster output eps file
           (type=string)

set_abstract(self, abstract)

Set the abstract of the poster
Parameters:
abstract - the text of the poster abstract
           (type=string)

set_address(self, address)

Set the address of the institution of those presenting the poster
Parameters:
address - the text of the address
           (type=string)

set_authors(self, authors)

Set the authors of the poster
Parameters:
authors - the text of the poster authors
           (type=string)

set_num_columns(self, num_columns)

Set the number of columns to use for the poster. Typically one would use two columns for portrait, and three for landscape.
Parameters:
num_columns - the number of columns to use
           (type=int)

set_orientation(self, orientation)

Set the orientation of the poster. Options are "portrait" or "landscape".
Parameters:
orientation - the page orientation of the poster
           (type=string)

set_size(self, size)

Set the size of the poster.

These are standard page sizes. It is a good idea to develop a poster at a size of "a4" and then for the final poster use "a0". It is also handy when at a poster session at a conference to have a4 size versions of the a0 poster to give out to people, so the a4 setting is also handy for that.
Parameters:
size - the size of the poster
           (type=string)

set_style(self, style)

Set the style of the poster. This is the name of a set of predefined fonts, sizes, colours etc for the text, the columns of the poster and the poster background.
Parameters:
style - the text of the name of the poster style to use
           (type=string)

set_title(self, title)

Set the title to use for the poster
Parameters:
title - the text of the poster title
           (type=string)

_make_abstract(self)

Make the abstract

_make_address(self)

Make the address

_make_authors(self)

Make the authors

_make_background(self)

Make the background of the poster

_make_columns(self)

Make the columns

_make_logos(self)

Make the logos

_make_title(self)

Make the title

_read_style(self, styleFname)

Read the talk style file
Parameters:
styleFname - The name of the style file to process
           (type=string)

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