home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 November / CPNL0711.ISO / communic / email / Evolution-2.8.2-2.msi / Data1.cab / editor.idl < prev    next >
Text File  |  2007-03-07  |  2KB  |  106 lines
  1. /* -*- Mode: IDL; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
  2. /*
  3.  * Interface for the HTML Editor.
  4.  *
  5.  * Authors:
  6.  *   Larry Ewing <lewing@ximian.com>
  7.  *   Radek Doulik <rodo@ximian.com>
  8.  *
  9.  * Copyright (C) 2000 Helix Code, Inc.
  10.  * Copyright (C) 2000, 2001 Ximian, Inc.
  11.  */
  12.  
  13. #include <Bonobo.idl>
  14.  
  15. module GNOME {
  16. module GtkHTML {
  17. module Editor {
  18.     interface Listener : Bonobo::Unknown {
  19.         any event (in string name, in any arg);
  20.     };
  21.  
  22.     interface Engine : Bonobo::Unknown {
  23.         attribute Listener listener;
  24.  
  25.         /*
  26.          * execute editor command
  27.          *
  28.          * return value: TRUE if command is done FALSE if command failed
  29.          */
  30.         boolean runCommand (in string command);
  31.  
  32.         /*
  33.          * return data of current paragraph
  34.          */
  35.         string getParagraphData (in string key);
  36.  
  37.         /*
  38.          * sets data on current paragraph
  39.          */
  40.         void setParagraphData (in string key, in string value);
  41.  
  42.         /*
  43.          * set data which are set to objects of given type while inserting
  44.          * we will use that to mark original text paragraph(s) in composer
  45.          * and use that data later in editing to implement better reply
  46.          * editing
  47.          */
  48.         void setObjectDataByType (in string type_name, in string key, in string data);
  49.  
  50.         /*
  51.          * goes thru document from current position and searches for data specified
  52.          * by key/value. level tells in which parent level to look for data. it goes
  53.          * thru by moving cursor forward and stops when data are found.
  54.          *
  55.          * returns true when data found.
  56.          */
  57.         boolean searchByData (in long level, in string klass, in string key, in string value);
  58.  
  59.         /*
  60.          * returns TRUE if current paragraph is empty (will be possibly replaced
  61.          * by more general iface)
  62.          */
  63.         boolean isParagraphEmpty ();
  64.  
  65.         /*
  66.          * return TRUE if previous paragraph is empty (will be possibly replaced
  67.          * by more general iface)
  68.          */
  69.         boolean isPreviousParagraphEmpty ();
  70.  
  71.         /*
  72.          * insert (parsed) html at current cursor position
  73.          */
  74.         void insertHTML (in string html);
  75.  
  76.         void freeze ();
  77.         void thaw ();
  78.  
  79.         void undoBegin (in string undo_name, in string redo_name);
  80.         void undoEnd ();
  81.  
  82.         void ignoreWord (in string word);
  83.  
  84.         /*
  85.          * drop undo drops all undo/redo queues
  86.          */
  87.         void dropUndo ();
  88.  
  89.         /*
  90.          * is there any undo event in undo queue?
  91.          */
  92.         boolean hasUndo ();
  93.     };
  94.     
  95.     struct URLRequestEvent {
  96.         string url;
  97.         Bonobo::Stream stream;
  98.     };
  99. };
  100. };
  101. };
  102.  
  103.  
  104.  
  105.  
  106.