atk.TextRange source code

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.TextRange;
26 
27 private import atk.c.functions;
28 public  import atk.c.types;
29 private import glib.MemorySlice;
30 private import glib.Str;
31 public  import gtkc.atktypes;
32 private import gtkd.Loader;
33 
34 
35 /**
36  * A structure used to describe a text range.
37  */
38 public final class TextRange
39 {
40 	/** the main Gtk struct */
41 	protected AtkTextRange* atkTextRange;
42 	protected bool ownedRef;
43 
44 	/** Get the main Gtk struct */
45 	public AtkTextRange* getTextRangeStruct(bool transferOwnership = false)
46 	{
47 		if (transferOwnership)
48 			ownedRef = false;
49 		return atkTextRange;
50 	}
51 
52 	/** the main Gtk struct as a void* */
53 	protected void* getStruct()
54 	{
55 		return cast(void*)atkTextRange;
56 	}
57 
58 	/**
59 	 * Sets our main struct and passes it to the parent class.
60 	 */
61 	public this (AtkTextRange* atkTextRange, bool ownedRef = false)
62 	{
63 		this.atkTextRange = atkTextRange;
64 		this.ownedRef = ownedRef;
65 	}
66 
67 	~this ()
68 	{
69 		if ( Linker.isLoaded(LIBRARY_ATK) && ownedRef )
70 			sliceFree(atkTextRange);
71 	}
72 
73 
74 	/**
75 	 * A rectangle giving the bounds of the text range
76 	 */
77 	public @property AtkTextRectangle bounds()
78 	{
79 		return atkTextRange.bounds;
80 	}
81 
82 	/** Ditto */
83 	public @property void bounds(AtkTextRectangle value)
84 	{
85 		atkTextRange.bounds = value;
86 	}
87 
88 	/**
89 	 * The start offset of a AtkTextRange
90 	 */
91 	public @property int startOffset()
92 	{
93 		return atkTextRange.startOffset;
94 	}
95 
96 	/** Ditto */
97 	public @property void startOffset(int value)
98 	{
99 		atkTextRange.startOffset = value;
100 	}
101 
102 	/**
103 	 * The end offset of a AtkTextRange
104 	 */
105 	public @property int endOffset()
106 	{
107 		return atkTextRange.endOffset;
108 	}
109 
110 	/** Ditto */
111 	public @property void endOffset(int value)
112 	{
113 		atkTextRange.endOffset = value;
114 	}
115 
116 	/**
117 	 * The text in the text range
118 	 */
119 	public @property string content()
120 	{
121 		return Str.toString(atkTextRange.content);
122 	}
123 
124 	/** Ditto */
125 	public @property void content(string value)
126 	{
127 		atkTextRange.content = Str.toStringz(value);
128 	}
129 
130 	/** */
131 	public static GType getType()
132 	{
133 		return atk_text_range_get_type();
134 	}
135 }