*
* Copyright 2001, 2002 Sun Microsystems Inc.,
* Copyright 2001, 2002 Ximian, Inc.
+ * Copyright 2010, 2011 Novell, Inc.
*
* This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Library General Public
+ * modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
- * version 2 of the License, or (at your option) any later version.
+ * version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Library General Public License for more details.
+ * Lesser General Public License for more details.
*
- * You should have received a copy of the GNU Library General Public
+ * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
*/
#include "atspi-private.h"
* atspi_image_get_image_description:
* @obj: a pointer to the #AtspiImage implementor on which to operate.
*
- * Get the description of the image displayed in an #AtspiImage object.
+ * Gets the description of the image displayed in an #AtspiImage object.
*
* Returns: a UTF-8 string describing the image.
**/
* atspi_image_get_image_size:
* @obj: a pointer to the #AtspiImage to query.
*
- * Get the size of the image displayed in a specified #AtspiImage object.
+ * Gets the size of the image displayed in a specified #AtspiImage object.
+ * The returned values are meaningful only if the Image has both
+ * STATE_VISIBLE and STATE_SHOWING.
+ *
+ * Returns: a pointer to an #AtspiPoint where x corresponds to
+ * the image's width and y corresponds to the image's height.
+ *
**/
AtspiPoint *
atspi_image_get_image_size (AtspiImage *obj, GError **error)
* @ctype: the desired coordinate system into which to return the results,
* (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
*
- * Get the minimum x and y coordinates of the image displayed in a
+ * Gets the minimum x and y coordinates of the image displayed in a
* specified #AtspiImage implementor.
+ * The returned values are meaningful only if the Image has both
+ * STATE_VISIBLE and STATE_SHOWING.
+ *
+ * Returns: a pointer to an #AtspiPoint where x and y correspond to the
+ * minimum coordinates of the displayed image.
+ *
**/
AtspiPoint *
atspi_image_get_image_position (AtspiImage *obj,
GError **error)
{
dbus_int32_t d_x, d_y;
- dbus_uint16_t d_ctype = ctype;
+ dbus_uint32_t d_ctype = ctype;
AtspiPoint ret;
ret.x = ret.y = 0;
* @ctype: the desired coordinate system into which to return the results,
* (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
*
- * Get the bounding box of the image displayed in a
+ * Gets the bounding box of the image displayed in a
* specified #AtspiImage implementor.
+ * The returned values are meaningful only if the Image has both
+ * STATE_VISIBLE and STATE_SHOWING.
+ *
+ * Returns: a pointer to an #AtspiRect corresponding to the image's bounding box. The minimum x and y coordinates,
+ * width, and height are specified.
**/
AtspiRect *
atspi_image_get_image_extents (AtspiImage *obj,
/**
* atspi_image_get_image_locale:
- * @obj: The #AtspiImage being queried.
+ * @obj: a pointer to the #AtspiImage to query.
*
- * Get the locale associated with an image and its textual representation.
+ * Gets the locale associated with an image and its textual representation.
*
- * Returns: A POSIX LC_MESSAGES-style Locale value for image description and text.
+ * Returns: A POSIX LC_MESSAGES-style locale value for image description and text.
**/
gchar *
atspi_image_get_image_locale (AtspiImage *obj, GError **error)