1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
/*
* This file is part of gtkD.
*
* gtkD is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 3
* of the License, or (at your option) any later version, with
* some exceptions, please read the COPYING file.
*
* gtkD 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with gtkD; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
*/
// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage
module atk.ImageIF;
private import atk.c.functions;
public import atk.c.types;
private import glib.Str;
public import gtkc.atktypes;
/**
* #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 interface ImageIF{
/** Get the main Gtk struct */
public AtkImage* getImageStruct(bool transferOwnership = false);
/** the main Gtk struct as a void* */
protected void* getStruct();
/** */
public static GType getType()
{
return atk_image_get_type();
}
/**
* Get a textual description of this image.
*
* Returns: a string representing the image description
*/
public string getImageDescription();
/**
* Retrieves the locale identifier associated to the #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.
*
* Since: 1.12
*/
public string getImageLocale();
/**
* Gets the position of the image in the form of a point specifying the
* images top-left corner.
*
* Params:
* 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.
* coordType = specifies whether the coordinates are relative to the screen
* or to the components top level window
*/
public void getImagePosition(out int x, out int y, AtkCoordType coordType);
/**
* 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).
*
* Params:
* 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.
*/
public void getImageSize(out int width, out int height);
/**
* Sets the textual description for this image.
*
* Params:
* description = a string description to set for @image
*
* Returns: boolean TRUE, or FALSE if operation could
* not be completed.
*/
public bool setImageDescription(string description);
}
|
