util/idl/Magnifier.idl

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2001 Sun Microsystems Inc.
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 #ifndef _ACCESSIBILITY_MAGNIFIER_IDL
  24 #define _ACCESSIBILITY_MAGNIFIER_IDL
  25
  26 #include <Bonobo.idl>
  27
  28 module Accessibility {
  29
  30   interface Magnifier : Bonobo::Unknown {
  31
  32     /**
  33      * #attribute MagFactor: a float indicating the current x and y magnification ratio.
  34      **/
  35     attribute float MagFactor;
  36
  37     /**
  38      * #attribute SourceDisplay: a @string containing the X display name
  39      *                            containing the region to be magnified.
  40      **/
  41     attribute string SourceDisplay;
  42
  43     /**
  44      * #attribute TargetDisplay: a @string containing the X display name
  45      *                           where the magnifier pixels are to be displayed.
  46      **/
  47     attribute string TargetDisplay;
  48
  49     /**
  50      * oneway void setROI:
  51      * Sets the region of interest for the magnifier.
  52      * @x1: the minimum X coordinate of the ROI bounding box
  53      * @x2: the maximum X coordinate of the ROI bounding box
  54      * @y1: the minimum Y coordinate of the ROI bounding box
  55      * @y2: the maximum Y coordinate of the ROI bounding box
  56      **/
  57     oneway void setROI (in long x1, in long y1, in long x2, in long y2);
  58
  59     /**
  60      * void exit:
  61      * Unmap the current magnifier from the display.
  62      **/
  63     void exit ();
  64
  65   };
  66 };
  67
  68 #endif
  69