doc/API

   1
   2 Sodipodi API's
   3 --------------
   4
   5 This file identifies and discusses various Application Programming
   6 Interfaces (API's) that exist in the codebase.  This is not intended to
   7 serve as a complete reference but as a high level overview; details
   8 should be sought from the appropriate code units.
   9
  10 Stable API's
  11 ============
  12
  13
  14 Unstable API's
  15 ==============
  16 Objects and API-s mentioned here, even if implemented,
  17 may change without notice.
  18
  19 Special item classes
  20 ~~~~~~~~~~~~~~~~~~~~
  21 SPGroup::SPBinder
  22 A group with special children
  23 For example - blender
  24 1. first
  25 2. second
  26 3... intermediate
  27
  28 Sodipodi New Object Tree TM
  29 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  30 Caution: This does not follow necessarily the Real (TM) implementation
  31 logic.  This should be updated to capture the correct stuff.
  32
  33  SPItem
  34  Virtual methods:
  35     void update (gdouble affine[]);
  36     void bbox ();
  37     void print (GnomePrintContext * gpc);
  38     gchar * description ();
  39     void read ();
  40     read_attr (const gchar * attr)
  41     GnomeCanvasItem * show (GnomeCanvasGroup * canvas_group, gpointer event_handler);
  42     hide (GnomeCanvas * canvas)
  43     paint (ArtPixBuf * buf, double affine[]);
  44  Signals:
  45  Methods:
  46     SPRepr * sp_item_repr ()
  47     SPItem * sp_item_parent ()
  48
  49  Constructors:
  50     sp_item_new (SPRepr * repr);
  51
  52  Destructors:
  53     sp_item_destroy (SPItem * item);
  54
  55  Derivatives:
  56
  57     SPGroup -> SPDocument
  58     SPImage
  59     SPPath -> SPShape -> SPRect
  60                       -> SPEllipse
  61                       -> SPChars -> SPText