1 /* 2 * This file is part of gtkD. 3 * 4 * gtkD is free software; you can redistribute it and/or modify 5 * it under the terms of the GNU Lesser General Public License 6 * as published by the Free Software Foundation; either version 3 7 * of the License, or (at your option) any later version, with 8 * some exceptions, please read the COPYING file. 9 * 10 * gtkD is distributed in the hope that it will be useful, 11 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * GNU Lesser General Public License for more details. 14 * 15 * You should have received a copy of the GNU Lesser General Public License 16 * along with gtkD; if not, write to the Free Software 17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA 18 */ 19 20 // generated automatically - do not change 21 // find conversion definition on APILookup.txt 22 // implement new conversion functionalities on the wrap.utils pakage 23 24 25 module atk.ImageIF; 26 27 private import glib.Str; 28 private import gtkc.atk; 29 public import gtkc.atktypes; 30 31 32 /** 33 * #AtkImage should be implemented by #AtkObject subtypes on behalf of 34 * components which display image/pixmap information onscreen, and 35 * which provide information (other than just widget borders, etc.) 36 * via that image content. For instance, icons, buttons with icons, 37 * toolbar elements, and image viewing panes typically should 38 * implement #AtkImage. 39 * 40 * #AtkImage primarily provides two types of information: coordinate 41 * information (useful for screen review mode of screenreaders, and 42 * for use by onscreen magnifiers), and descriptive information. The 43 * descriptive information is provided for alternative, text-only 44 * presentation of the most significant information present in the 45 * image. 46 */ 47 public interface ImageIF{ 48 /** Get the main Gtk struct */ 49 public AtkImage* getImageStruct(); 50 51 /** the main Gtk struct as a void* */ 52 protected void* getStruct(); 53 54 55 /** 56 * Get a textual description of this image. 57 * 58 * Return: a string representing the image description 59 */ 60 public string getImageDescription(); 61 62 /** 63 * Return: a string corresponding to the POSIX 64 * LC_MESSAGES locale used by the image description, or %NULL if the 65 * image does not specify a locale. 66 * 67 * Since: 1.12 68 */ 69 public string getImageLocale(); 70 71 /** 72 * Gets the position of the image in the form of a point specifying the 73 * images top-left corner. 74 * 75 * Params: 76 * x = address of #gint to put x coordinate position; otherwise, -1 if value cannot be obtained. 77 * y = address of #gint to put y coordinate position; otherwise, -1 if value cannot be obtained. 78 * coordType = specifies whether the coordinates are relative to the screen 79 * or to the components top level window 80 */ 81 public void getImagePosition(int* x, int* y, AtkCoordType coordType); 82 83 /** 84 * Get the width and height in pixels for the specified image. 85 * The values of @width and @height are returned as -1 if the 86 * values cannot be obtained (for instance, if the object is not onscreen). 87 * 88 * Params: 89 * width = filled with the image width, or -1 if the value cannot be obtained. 90 * height = filled with the image height, or -1 if the value cannot be obtained. 91 */ 92 public void getImageSize(int* width, int* height); 93 94 /** 95 * Sets the textual description for this image. 96 * 97 * Params: 98 * description = a string description to set for @image 99 * 100 * Return: boolean TRUE, or FALSE if operation could 101 * not be completed. 102 */ 103 public bool setImageDescription(string description); 104 }