diff options
| -rw-r--r-- | ChangeLog | 8 | ||||
| -rwxr-xr-x | autogen.sh | 2 | ||||
| -rw-r--r-- | configure.in | 2 | ||||
| -rw-r--r-- | idl/GNOME_Magnifier.idl | 79 |
4 files changed, 46 insertions, 45 deletions
@@ -1,3 +1,11 @@ +2006-01-19 Bill Haneman <bill.haneman@sun.com> + + * configure.in: Revved to 0.12.3. + + * autogen.sh: Require automake 1.9 (bug #326161). + + * idl/GNOME_Magnifier.idl: Make docs doxygen-compatible. + 2005-12-16 Bill Haneman <bill.haneman@sun.com> Patch from Carlos Diogenes for bug #171465, thanks! @@ -6,4 +6,4 @@ test -z "$srcdir" && srcdir=. PKG_NAME="gnome-mag" -USE_GNOME2_MACROS=1 . gnome-autogen.sh +USE_GNOME2_MACROS=1 REQUIRED_AUTOMAKE_VERSION=1.9 . gnome-autogen.sh diff --git a/configure.in b/configure.in index 2a4d0df..3eb5956 100644 --- a/configure.in +++ b/configure.in @@ -19,7 +19,7 @@ GNOME_MAG_CURRENT=`expr $GNOME_MAG_MINOR_VERSION - $GNOME_MAG_INTERFACE_AGE` dnl increment any time the source you release changes; set to dnl 0 if you increment CURRENT -GNOME_MAG_REVISION=2 +GNOME_MAG_REVISION=3 GNOME_MAG_MICRO_VERSION=$GNOME_MAG_REVISION dnl increment if any interfaces have been added; set to 0 diff --git a/idl/GNOME_Magnifier.idl b/idl/GNOME_Magnifier.idl index 16980d7..2713445 100644 --- a/idl/GNOME_Magnifier.idl +++ b/idl/GNOME_Magnifier.idl @@ -54,69 +54,64 @@ module GNOME { }; /** - * boolean setMagFactor: sets the current x and y magnification ratio. + * 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. - * @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. + * @param magX the magnification factor in the x direction for the specified region. + * @param 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. **/ boolean setMagFactor (in float magX, in float magY); /** - * void getMagFactor: gets the current x and y magnification ratios. + * Get the current x and y magnification ratios. * (Convenience method for getting mag-factor-x and mag-factor-y properties). - * @magX: the magnification factor in the x direction for the specified region. - * @magY: the magnification factor in the x direction for the specified region. + * @param magX: the magnification factor in the x direction for the specified region. + * @param magY: the magnification factor in the x direction for the specified region. **/ void getMagFactor (out float magX, out float magY); /** - * PropertyBag getProperties: gets the current property settings for this ZoomRegion. + * 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. + * @returns a Bonobo::PropertyBag containing the ZoomRegion's properties. **/ Bonobo::PropertyBag getProperties (); /** - * oneway void setROI: - * Sets the region of interest for the magnifier. - * @bounds: the ROI bounding box + * Set the region of interest for the magnifier. + * @param bounds: the ROI bounding box **/ oneway void setROI (in RectBounds bounds); /** - * void markDirty: - * Marks the zoom region or a sub-region 'dirty' and in need of updating. - * Note that this region will be clipped to the area currently visible in + * 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. - * @dirtyRegion: the bounding box of the dirty region. + * @param dirtyRegion: the bounding box of the dirty region. **/ void markDirty (in RectBounds dirtyRegion); /** - * RectBounds getROI: - * Queries a specific zoom region for its ROI. - * returns: the RectBounds bounding box of the zoom ROI. + * Query a specific zoom region for its ROI. + * @returns the RectBounds bounding box of the zoom ROI. **/ RectBounds getROI (); /** - * void moveResize: - * Moves and resizes the specified zoom region on the target display. + * Move and resize the specified zoom region on the target display. * (Convenience method for setting "viewport" property). - * @bounds: the bounding box, in target display coordinates, of the ZoomRegion's + * @param bounds: the bounding box, in target display coordinates, of the ZoomRegion's * display viewport. **/ void moveResize (in RectBounds bounds); /** - * void dispose: * Remove the specified zoom region from the magnifier and destroy it. **/ void dispose (); @@ -128,63 +123,61 @@ module GNOME { interface Magnifier : Bonobo::Unknown { /** - * #attribute SourceDisplay: a @string containing the X display name - * containing the region to be magnified. + * a \c string specifying the name of the display and screen + * (on X Windows systems, as used by XOpenDisplay) on which the "source" + * pixels (e.g. unmagnified image) are located. **/ attribute string SourceDisplay; /** - * #attribute TargetDisplay: a @string containing the X display name - * where the magnifier pixels are to be displayed. + * a \c string specifying the name of the display and screen + * onto which the magnified image is to be placed. **/ attribute string TargetDisplay; /** - * PropertyBag getProperties: gets the current property settings for this Magnifier. + * Get 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. + * @returns a Bonobo::PropertyBag containing the Magnifier's properties. **/ Bonobo::PropertyBag getProperties (); /** - * ZoomRegion createZoomRegion: - * Creates a new zoom region for the magnifier. - * The new region is initially unmanaged'. - * @zx: the scale factor in the x direction for the new zoom region - * @zy: the scale factor in the y direction for the new zoom region - * @ROI: the initial ROI of the zoom region. RectBounds of negative width/height + * Create a new zoom region for the magnifier. + * The new region is initially 'unmanaged'; that is, it is not associated with + * a particular sub-region of the "source" display. + * @param zx: the scale factor in the x direction for the new zoom region + * @param zy: the scale factor in the y direction for the new zoom region + * @param ROI: the initial ROI of the zoom region. RectBounds of negative width/height * indicates that the zoom region has no initial ROI. - * @viewport: the initial bounds of the ZoomRegion's viewport, in + * @param viewport: the initial bounds of the ZoomRegion's viewport, in * the target display coordinate system. + * @returns the newly created ZoomRegion. **/ ZoomRegion createZoomRegion (in float zx, in float zy, in RectBounds ROI, in RectBounds viewport); /** - * ZoomRegionList getZoomRegions: - * returns a ZoomRegionList including all currently defined ZoomRegions + * @returns a ZoomRegionList including all currently defined ZoomRegions * for this Magnifier instance. **/ ZoomRegionList getZoomRegions (); /** - * boolean addZoomRegion: - * add a new ZoomRegion to the list of currently defined ZoomRegions + * 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. + * @returns \c True if successful, \c False if the ZoomRegion cannot be added. **/ boolean addZoomRegion (in ZoomRegion region); /** - * void clearAllZoomRegions: * Clears and destroys all currently defined zoom regions. **/ void clearAllZoomRegions (); /** - * void dispose: * Unmap the current magnifier from the display, destroy its resources, and exit. **/ void dispose (); |