Table of Contents

Class: textatom bkchem/textatom.py

Class TEXTATOM --------------------------------------------------

Base Classes   
meta_enabled
area_colored
point_drawable
text_like
child_with_paper
vertex_common
oasa.graph.vertex
Methods   
__init__
__str__
_get_charge
_get_drawn
_get_font_size
_get_molecule
_get_name
_get_parent
_get_pos
_get_show
_get_show_hydrogens
_get_valency
_get_x
_get_xml_text
_get_y
_get_z
_set_charge
_set_font_size
_set_molecule
_set_name
_set_parent
_set_pos
_set_show
_set_show_hydrogens
_set_valency
_set_x
_set_xml_text
_set_y
_set_z
atoms_bound_to
bbox
copy_settings
decide_pos
delete
draw
focus
get_formula_dict
get_free_valency
get_ftext
get_occupied_valency
get_package
get_text
get_xy
get_xyz
lift
lift_selector
move
move_to
read_package
redraw
scale_font
select
set_name
toggle_center
transform
unfocus
unselect
update_font
  __init__ 
__init__ (
        self,
        standard=None,
        xy=(),
        package=None,
        molecule=None,
        )

  __str__ 
__str__ ( self )

  _get_charge 
_get_charge ( self )

LOOK charge

  _get_drawn 
_get_drawn ( self )

is the atoms drawn? on the paper or just virtual

drawn

  _get_font_size 
_get_font_size ( self )

font_size (override of text_like.xml_text)

  _get_molecule 
_get_molecule ( self )

molecule

  _get_name 
_get_name ( self )

name

  _get_parent 
_get_parent ( self )

parent

  _get_pos 
_get_pos ( self )

pos

  _get_show 
_get_show ( self )

JUST TO MIMICK ATOM show

  _get_show_hydrogens 
_get_show_hydrogens ( self )

show_hydrogens

  _get_valency 
_get_valency ( self )

valency (setting)

  _get_x 
_get_x ( self )

x

  _get_xml_text 
_get_xml_text ( self )

xml_text (override of text_like.xml_text)

  _get_y 
_get_y ( self )

y

  _get_z 
_get_z ( self )

z

  _set_charge 
_set_charge ( self,  charge )

  _set_font_size 
_set_font_size ( self,  font_size )

  _set_molecule 
_set_molecule ( self,  mol )

  _set_name 
_set_name ( self,  name )

  _set_parent 
_set_parent ( self,  par )

  _set_pos 
_set_pos ( self,  pos )

  _set_show 
_set_show ( self,  show )

  _set_show_hydrogens 
_set_show_hydrogens ( self,  show_hydrogens )

  _set_valency 
_set_valency ( self,  val )

  _set_x 
_set_x ( self,  x )

  _set_xml_text 
_set_xml_text ( self,  xml_text )

  _set_y 
_set_y ( self,  y )

  _set_z 
_set_z ( self,  z )

  atoms_bound_to 
atoms_bound_to ( self )

LOOK

  bbox 
bbox ( self )

returns the bounding box of the object as a list of [x1,y1,x2,y2]

  copy_settings 
copy_settings ( self,  other )

copies settings of self to other, does not check if other is capable of receiving it

  decide_pos 
decide_pos ( self )

  delete 
delete ( self )

  draw 
draw ( self,  redraw=False )

draws atom with respect to its properties

  focus 
focus ( self )

  get_formula_dict 
get_formula_dict ( self )

returns formula as dictionary that can be passed to functions in periodic_table

  get_free_valency 
get_free_valency ( self )

returns free valency of atom.

  get_ftext 
get_ftext ( self )

  get_occupied_valency 
get_occupied_valency ( self )

  get_package 
get_package ( self,  doc )

returns a DOM element describing the object in CDML, doc is the parent document which is used for element creation (the returned element is not inserted into the document)

  get_text 
get_text ( self )

  get_xy 
get_xy ( self )

  get_xyz 
get_xyz ( self,  real=0 )

returns atoms coordinates, default are screen coordinates, real!=0 changes it to real coordinates (these two are usually different for imported molecules)

  lift 
lift ( self )

  lift_selector 
lift_selector ( self )

  move 
move (
        self,
        dx,
        dy,
        dont_move_marks=0,
        )

moves object with his selector (when present)

  move_to 
move_to (
        self,
        x,
        y,
        dont_move_marks=0,
        )

  read_package 
read_package ( self,  package )

reads the dom element package and sets internal state according to it

Exceptions   
TypeError, "not text atom"
  redraw 
redraw ( self,  suppress_reposition=0 )

  scale_font 
scale_font ( self,  ratio )

scales font of atom. does not redraw !!

  select 
select ( self )

  set_name 
set_name (
        self,
        name,
        interpret=1,
        occupied_valency=None,
        )

  toggle_center 
toggle_center ( self,  mode=0 )

toggles the centering of text between center-first and center-last(mode=0) or sets it strictly - mode=-1, mode=1

  transform 
transform ( self,  tr )

  unfocus 
unfocus ( self )

  unselect 
unselect ( self )

  update_font 
update_font ( self )


Table of Contents

This document was automatically generated on Wed Jun 1 11:05:30 2005 by HappyDoc version 2.1