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 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
|
/*
* 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 pango.PgAttributeIterator;
private import glib.ListSG;
private import gobject.ObjectG;
public import gtkc.pangotypes;
private import pango.PgAttribute;
private import pango.PgFontDescription;
private import pango.PgLanguage;
private import pango.c.functions;
public import pango.c.types;
/**
* The #PangoAttrIterator structure is used to represent an
* iterator through a #PangoAttrList. A new iterator is created
* with pango_attr_list_get_iterator(). Once the iterator
* is created, it can be advanced through the style changes
* in the text using pango_attr_iterator_next(). At each
* style change, the range of the current style segment and the
* attributes currently in effect can be queried.
*/
public class PgAttributeIterator
{
/** the main Gtk struct */
protected PangoAttrIterator* pangoAttrIterator;
protected bool ownedRef;
/** Get the main Gtk struct */
public PangoAttrIterator* getPgAttributeIteratorStruct(bool transferOwnership = false)
{
if (transferOwnership)
ownedRef = false;
return pangoAttrIterator;
}
/** the main Gtk struct as a void* */
protected void* getStruct()
{
return cast(void*)pangoAttrIterator;
}
/**
* Sets our main struct and passes it to the parent class.
*/
public this (PangoAttrIterator* pangoAttrIterator, bool ownedRef = false)
{
this.pangoAttrIterator = pangoAttrIterator;
this.ownedRef = ownedRef;
}
/**
* Copy a #PangoAttrIterator
*
* Returns: the newly allocated
* #PangoAttrIterator, which should be freed with
* pango_attr_iterator_destroy().
*/
public PgAttributeIterator copy()
{
auto p = pango_attr_iterator_copy(pangoAttrIterator);
if(p is null)
{
return null;
}
return ObjectG.getDObject!(PgAttributeIterator)(cast(PangoAttrIterator*) p, true);
}
/**
* Destroy a #PangoAttrIterator and free all associated memory.
*/
public void destroy()
{
pango_attr_iterator_destroy(pangoAttrIterator);
}
/**
* Find the current attribute of a particular type at the iterator
* location. When multiple attributes of the same type overlap,
* the attribute whose range starts closest to the current location
* is used.
*
* Params:
* type = the type of attribute to find.
*
* Returns: the current attribute of the given type,
* or %NULL if no attribute of that type applies to the
* current location.
*/
public PgAttribute get(PangoAttrType type)
{
auto p = pango_attr_iterator_get(pangoAttrIterator, type);
if(p is null)
{
return null;
}
return ObjectG.getDObject!(PgAttribute)(cast(PangoAttribute*) p);
}
/**
* Gets a list of all attributes at the current position of the
* iterator.
*
* Returns: a list of
* all attributes for the current range.
* To free this value, call pango_attribute_destroy() on
* each value and g_slist_free() on the list.
*
* Since: 1.2
*/
public ListSG getAttrs()
{
auto p = pango_attr_iterator_get_attrs(pangoAttrIterator);
if(p is null)
{
return null;
}
return new ListSG(cast(GSList*) p, true);
}
/**
* Get the font and other attributes at the current iterator position.
*
* Params:
* desc = a #PangoFontDescription to fill in with the current values.
* The family name in this structure will be set using
* pango_font_description_set_family_static() using values from
* an attribute in the #PangoAttrList associated with the iterator,
* so if you plan to keep it around, you must call:
* <literal>pango_font_description_set_family (desc, pango_font_description_get_family (desc))</literal>.
* language = if non-%NULL, location to store language tag for item, or %NULL
* if none is found.
* extraAttrs = if non-%NULL,
* location in which to store a list of non-font
* attributes at the the current position; only the highest priority
* value of each attribute will be added to this list. In order
* to free this value, you must call pango_attribute_destroy() on
* each member.
*/
public void getFont(PgFontDescription desc, out PgLanguage language, out ListSG extraAttrs)
{
PangoLanguage* outlanguage = null;
GSList* outextraAttrs = null;
pango_attr_iterator_get_font(pangoAttrIterator, (desc is null) ? null : desc.getPgFontDescriptionStruct(), &outlanguage, &outextraAttrs);
language = ObjectG.getDObject!(PgLanguage)(outlanguage);
extraAttrs = new ListSG(outextraAttrs);
}
/**
* Advance the iterator until the next change of style.
*
* Returns: %FALSE if the iterator is at the end of the list, otherwise %TRUE
*/
public bool next()
{
return pango_attr_iterator_next(pangoAttrIterator) != 0;
}
/**
* Get the range of the current segment. Note that the
* stored return values are signed, not unsigned like
* the values in #PangoAttribute. To deal with this API
* oversight, stored return values that wouldn't fit into
* a signed integer are clamped to %G_MAXINT.
*
* Params:
* start = location to store the start of the range
* end = location to store the end of the range
*/
public void range(out int start, out int end)
{
pango_attr_iterator_range(pangoAttrIterator, &start, &end);
}
}
|