InterfaceDescription

Webs: Faemalia -:- Greatprawn -:- Playground -:- Technical -:- Tweak
Technical Web Sections: Register -:- Users -:- Changes -:- Index -:- Search -:- Statistics

Here's the raw interface description that Hans mailed to the dia list:

dia.active_display()      DiaDisplay
dia.diagrams()         DiaDiagram[n]
dia.get_object_type(string)   DiaObjectType   'name_of_object_type
dia.load(string)                  'filename
dia.register_export(string,string,object)      'name,extension,DiaRenderer
dia.register_callback(string,string,function)   'description,menupath,callback(DiaDiagramData,int)
dia.update_all()

DiaArrow
  type      int
  width      double
  length      double

DiaBezPoint
  p1         DiaPoint
  p2         DiaPoint
  p3         DiaPoint

DiaColor
  red         double
  green      double
  blue      double

DiaConnectionPoint
  connected      DiaObject[n]
  object      DiaObject
  pos         double[n]   '(x,y)

DiaDiagram
  raise_layer()
  lower_layer()
  add_layer(string[,int])   DiaLayer   'name, optional poisition
  set_active_layer(DiaLayer)
  delete_layer(DiaLayer)
  select(DiaObject)
  is_selected(DiaObject)   int
  unselect(DiaObject)
  remove_all_selected()
  update_extents()
  get_sorted_selected()      DiaObject[n]
  get_sorted_selected_remove()
  add_update(double,double,double,double)
  add_update_all()
  flush()
  find_clicked_object((double,double),double)   DiaObject '(x,y), distance
  find_closest_handle(double,double)   DiaHandle
  find_closest_connectionpoint(double,double)      (DiaHandle,DiaObject) 'x,y
  group_selected()
  ungroup_selected()
  save([string])   int   'optional filename

DiaDiagramData
  extents      DiaRectangle
  bg_color      DiaColor
  paper      
  grid.width   double[2]
  grid.visible   int[2]
  hguides      double[n]
  vguides      double[n]
  layers      DiaLayer[n]
  active_layer   DiaLayer
  selected      DiaObject[n]

DiaDisplay
  diagram      DiaDiagram
  origin      double[2]   'todo? DiaPoint
  visible      double[4]   'todo? DiaRectangle
  zoom_factor   double
  add_update_all()
  flush()
  set_origion(double,double)
  zoom(double,double,double)   'pt.x, pt.x, factor
  resize_canvas(int,int)   'width, height
  close()
  set_title(string)
  scroll(double,double)      'delta x,y
  scroll_up()
  scroll_down()
  scroll_left()
  scroll_right()

DiaError
  write(object)   'writes obeject as string

DiaExportFilter
  

DiaFont
  name   string

DiaHandle
  connect_type   int
  connected_to   DiaConnectionPoint
  id         int
  pos         double[2]   '(x,y)
  type      int

DiaImage
  width      int
  height      int
  rgb_data      char[widht*height*3]
  mask_data      char[widht*height]
  filename      string

DiaLayer
  extents      double[4]      '(top,left,bottom,right)
  name      string
  objects      DiaObject[n]
  visible      int

  destroy()
  object_index()   int
  add_object(DiaObject[,int])      'object, optional index 'at'
  remove_object(DiaObject)
  find_objects_in_rectangle(double,double,double,double)   DiaObject   'top,left,right,bottom
  find_closest_object(double,double,double)   DiaObject   'x,y,maxdist
  find_closest_connection_point(double,double)   (double,DiaConnectionPoint) '(distance, cpoint)
  update_extents()

DiaObject
  bounding_box   DiaRectangle
  connections   DiaConnectionPoint[n]
  handles      DiaHandle[n]
  properties   DiaProperties
  type      DiaObjectType

  destroy()
  distance_from(double,double)   double
  copy()      DiaObject
  move(double,double)         'x,y
  move_handle(DiaHandle,(double,double),int,int)   'handle, (point.x, point.y), reason, modifiers

DiaObjectType
  name      string
  version      int

  create(double,double[,int])      (DiaObject,DiaHandle,DiaHandle)   'x,y,optional user_data pointer

DiaPoint
  x         double
  y         double

DiaProperties
  <dictionary interface>

DiaProperty
  name      string
  type      int         'type enumeration
  value      <object>      'as (Dia)Python object

DiaRectangle
  top         <int|double>
  left      <int|double>
  right      <int|double>
  bottom      <int|double>

-- LarsClausen - 26 Dec 2002


Edit -:- Attach -:- Ref-By -:- Printable -:- More