atk.Image.Image Class Reference

List of all members.

Detailed Description

Description AtkImage should be implemented by AtkObject subtypes on behalf of components which display image/pixmap information onscreen, and which provide information (other than just widget borders, etc.

) via that image content. For instance, icons, buttons with icons, toolbar elements, and image viewing panes typically should implement AtkImage. AtkImage primarily provides two types of information: coordinate information (useful for screen review mode of screenreaders, and for use by onscreen magnifiers), and descriptive information. The descriptive information is provided for alternative, text-only presentation of the most significant information present in the image.


Public Member Functions

AtkImagegetImageStruct ()
 this (AtkImage *atkImage)
 Sets our main struct and passes it to the parent class.
void getImagePosition (int *x, int *y, AtkCoordType coordType)
 Gets the position of the image in the form of a point specifying the images top-left corner.
char[] getImageDescription ()
 Get a textual description of this image.
int setImageDescription (char[] description)
 Sets the textual description for this image.
void getImageSize (int *width, int *height)
 Get the width and height in pixels for the specified image.
char[] getImageLocale ()
 Since ATK 1.12 image: An AtkImage Returns: a string corresponding to the POSIX LC_MESSAGES locale used by the image description, or NULL if the image does not specify a locale.

Protected Member Functions

void * getStruct ()
 the main Gtk struct as a void*

Protected Attributes

AtkImageatkImage
 the main Gtk struct


Constructor & Destructor Documentation

atk.Image.Image.this ( AtkImage atkImage  ) 

Sets our main struct and passes it to the parent class.


Member Function Documentation

char [] atk.Image.Image.getImageDescription (  ) 

Get a textual description of this image.

image: a GObject instance that implements AtkImageIface Returns: a string representing the image description

char [] atk.Image.Image.getImageLocale (  ) 

Since ATK 1.12 image: An AtkImage Returns: a string corresponding to the POSIX LC_MESSAGES locale used by the image description, or NULL if the image does not specify a locale.

void atk.Image.Image.getImagePosition ( int x,
int y,
AtkCoordType  coordType 
)

Gets the position of the image in the form of a point specifying the images top-left corner.

image: a GObject instance that implements AtkImageIface x: address of gint to put x coordinate position; otherwise, -1 if value cannot be obtained. y: address of gint to put y coordinate position; otherwise, -1 if value cannot be obtained. coord_type: specifies whether the coordinates are relative to the screen or to the components top level window

void atk.Image.Image.getImageSize ( int width,
int height 
)

Get the width and height in pixels for the specified image.

The values of width and height are returned as -1 if the values cannot be obtained (for instance, if the object is not onscreen). image: a GObject instance that implements AtkImageIface width: filled with the image width, or -1 if the value cannot be obtained. height: filled with the image height, or -1 if the value cannot be obtained.

AtkImage* atk.Image.Image.getImageStruct (  ) 

void* atk.Image.Image.getStruct (  )  [protected]

the main Gtk struct as a void*

int atk.Image.Image.setImageDescription ( char[]  description  ) 

Sets the textual description for this image.

image: a GObject instance that implements AtkImageIface description: a string description to set for image Returns: boolean TRUE, or FALSE if operation could not be completed.


Member Data Documentation

AtkImage* atk.Image.Image.atkImage [protected]

the main Gtk struct


SourceForge.net Logo DSource.org Logo digitalmars.com Logo