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

GNOME::Magnifier::ZoomRegion Interface Reference

import "GNOME_Magnifier.idl";


Public Types

enum  AlignPolicy {
  ALIGN_CENTER,
  ALIGN_MIN,
  ALIGN_MAX
}
 Enum of the possible align policies. More...
enum  ScrollingPolicy {
  SCROLL_FASTEST,
  SCROLL_FAST,
  SCROLL_NORMAL,
  SCROLL_SMOOTH,
  SCROLL_SMOOTHEST
}

Public Member Functions

boolean setMagFactor (in float magX, in float magY)
 Set the current x and y magnification ratio.
void getMagFactor (out float magX, out float magY)
 Get the current x and y magnification ratios.
Bonobo::PropertyBag getProperties ()
 Gets the current property settings for this ZoomRegion.
oneway void setROI (in RectBounds bounds)
 Set the region of interest for the magnifier.
void markDirty (in RectBounds dirtyRegion)
 Mark the zoom region or a sub-region 'dirty' and in need of updating.
RectBounds getROI ()
 Query a specific zoom region for its ROI.
void moveResize (in RectBounds bounds)
 Move and resize the specified zoom region on the target display.
void dispose ()
 Remove the specified zoom region from the magnifier and destroy it.


Detailed Description

Definition at line 40 of file GNOME_Magnifier.idl.


Member Enumeration Documentation

enum GNOME::Magnifier::ZoomRegion::AlignPolicy
 

Enum of the possible align policies.

These represents the possible align policies in the magnifier. The default is ALIGN_CENTER, i.e., the pointer will always stay in the center of the magnified area. ALIGN_MIN defines that the pointer will be in the left superior corner of the magnified area and ALIGN_MAX defines that the pointer will be in the right inferior corner of the magnified area.

Enumerator:
ALIGN_CENTER 
ALIGN_MIN 
ALIGN_MAX 

Definition at line 51 of file GNOME_Magnifier.idl.

enum GNOME::Magnifier::ZoomRegion::ScrollingPolicy
 

Enumerator:
SCROLL_FASTEST 
SCROLL_FAST 
SCROLL_NORMAL 
SCROLL_SMOOTH 
SCROLL_SMOOTHEST 

Definition at line 57 of file GNOME_Magnifier.idl.


Member Function Documentation

boolean GNOME::Magnifier::ZoomRegion::setMagFactor in float  magX,
in float  magY
 

Set the current x and y magnification ratio.

(Convenience method for setting mag-factor-x and mag-factor-y properties). Note that if the zoom region's target hasn't yet been realized or mapped to the display, we will not be able to detect failure, so a return of TRUE must be taken on advisement if the operation is performed on a newly-created zoom region.

Parameters:
magX the magnification factor in the x direction for the specified region.
magY the magnification factor in the x direction for the specified region.
Returns:
TRUE if operation succeeded, FALSE if the requested mag factor cannot be set.

void GNOME::Magnifier::ZoomRegion::getMagFactor out float  magX,
out float  magY
 

Get the current x and y magnification ratios.

(Convenience method for getting mag-factor-x and mag-factor-y properties).

Parameters:
magX the magnification factor in the x direction for the specified region.
magY the magnification factor in the x direction for the specified region.

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

Gets the current property settings for this ZoomRegion.

Properties managed by the ZoomRegion include "smoothing-type", "contrast", "inverse-video", "border-size", "border-color", "x-alignment", "y-alignment", "is-managed", "viewport", "mag-factor-x", "mag-factor-y".

Returns:
a Bonobo::PropertyBag containing the ZoomRegion's properties.

oneway void GNOME::Magnifier::ZoomRegion::setROI in RectBounds  bounds  ) 
 

Set the region of interest for the magnifier.

Parameters:
bounds the ROI bounding box

void GNOME::Magnifier::ZoomRegion::markDirty in RectBounds  dirtyRegion  ) 
 

Mark the zoom region or a sub-region 'dirty' and in need of updating.

Note:
This region will be clipped to the area currently visible in the target region.
Parameters:
dirtyRegion the bounding box of the dirty region.

RectBounds GNOME::Magnifier::ZoomRegion::getROI  ) 
 

Query a specific zoom region for its ROI.

Returns:
the RectBounds bounding box of the zoom ROI.

void GNOME::Magnifier::ZoomRegion::moveResize in RectBounds  bounds  ) 
 

Move and resize the specified zoom region on the target display.

(Convenience method for setting "viewport" property).

Parameters:
bounds the bounding box, in target display coordinates, of the ZoomRegion's display viewport.

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

Remove the specified zoom region from the magnifier and destroy it.


The documentation for this interface was generated from the following file:
Generated on Mon May 15 16:14:03 2006 for gnome-mag by  doxygen 1.4.4