Main Page | Namespace List | Data Structures | Directories | File List | Namespace Members | Data Fields | Globals

GNOME::Magnifier::Magnifier Interface Reference

import "GNOME_Magnifier.idl";


Public Member Functions

Bonobo::PropertyBag getProperties ()
ZoomRegion createZoomRegion (in float zx, in float zy, in RectBounds ROI, in RectBounds viewport)
ZoomRegionList getZoomRegions ()
boolean addZoomRegion (in ZoomRegion region)
void clearAllZoomRegions ()
void dispose ()

Data Fields

attribute string SourceDisplay
attribute string TargetDisplay


Member Function Documentation

boolean GNOME::Magnifier::Magnifier::addZoomRegion in ZoomRegion  region  ) 
 

boolean addZoomRegion: add a new ZoomRegion to the list of currently defined ZoomRegions for this Magnifier instance. returns: true if successful, false if the ZoomRegion cannot be added.

void GNOME::Magnifier::Magnifier::clearAllZoomRegions  ) 
 

void clearAllZoomRegions: Clears and destroys all currently defined zoom regions.

ZoomRegion GNOME::Magnifier::Magnifier::createZoomRegion in float  zx,
in float  zy,
in RectBounds  ROI,
in RectBounds  viewport
 

ZoomRegion createZoomRegion: Creates a new zoom region for the magnifier. The new region is initially unmanaged'. : the scale factor in the x direction for the new zoom region : the scale factor in the y direction for the new zoom region : the initial ROI of the zoom region. RectBounds of negative width/height indicates that the zoom region has no initial ROI. : the initial bounds of the ZoomRegion's viewport, in the target display coordinate system.

void GNOME::Magnifier::Magnifier::dispose  ) 
 

void dispose: Unmap the current magnifier from the display, destroy its resources, and exit.

Bonobo::PropertyBag GNOME::Magnifier::Magnifier::getProperties  ) 
 

PropertyBag getProperties: gets the current property settings for this Magnifier. Properties managed by the magnifier include "cursor-set", "cursor-size", "cursor-mag-factor", "target-display-bounds", "source-display-size". returns: a Bonobo::PropertyBag containing the Magnifier's properties.

ZoomRegionList GNOME::Magnifier::Magnifier::getZoomRegions  ) 
 

ZoomRegionList getZoomRegions: returns a ZoomRegionList including all currently defined ZoomRegions for this Magnifier instance.


Field Documentation

attribute string GNOME::Magnifier::Magnifier::SourceDisplay
 

attribute SourceDisplay: a containing the X display name containing the region to be magnified.

attribute string GNOME::Magnifier::Magnifier::TargetDisplay
 

attribute TargetDisplay: a containing the X display name where the magnifier pixels are to be displayed.


The documentation for this interface was generated from the following file:
Generated on Wed Oct 26 12:55:29 2005 for gnome-mag by  doxygen 1.4.3