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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
// -*- c++ -*-
// Generated by gtkmmproc -- DO NOT MODIFY!
#ifndef _PANGOMM_LAYOUTLINE_H
#define _PANGOMM_LAYOUTLINE_H
#include <glibmm.h>
/* $Id$ */
/* layoutline.h
*
* Copyright (C) 1998-1999 The gtkmm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <glibmm/slisthandle.h> // For the Glib::SListHandle typedef
#include <pangomm/rectangle.h>
#include <pango/pango-layout.h>
namespace Pango
{
class Layout;
/** A Pango::LayoutLine represents one of the lines resulting from laying out a paragraph via Pango::Layout.
* Pango::LayoutLine objects are obtained by calling Pango::Layout::get_line()
* and are only valid until the text, attributes, or settings of the parent Pango::Layout are modified.
* Routines for rendering Pango::Layout objects are provided in code specific to each rendering system.
*/
class LayoutLine
{
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef LayoutLine CppObjectType;
typedef PangoLayoutLine BaseObjectType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
// For use with Glib::RefPtr<> only.
void reference() const;
void unreference() const;
///Provides access to the underlying C instance.
PangoLayoutLine* gobj();
///Provides access to the underlying C instance.
const PangoLayoutLine* gobj() const;
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
PangoLayoutLine* gobj_copy() const;
protected:
// Do not derive this. Pango::LayoutLine can neither be constructed nor deleted.
LayoutLine();
void operator delete(void*, size_t);
private:
// noncopyable
LayoutLine(const LayoutLine&);
LayoutLine& operator=(const LayoutLine&);
public:
/** Converts from x offset to the byte index of the corresponding
* character within the text of the layout. If @a x_pos is outside the line,
* @a index and @a trailing will point to the very first or very last position
* in the line. This determination is based on the resolved direction
* of the paragraph; for example, if the resolved direction is
* right-to-left, then an X position to the right of the line (after it)
* results in 0 being stored in @a index and @a trailing . An X position to the
* left of the line results in @a index pointing to the (logical) last
* grapheme in the line and @a trailing being set to the number of characters
* in that grapheme. The reverse is true for a left-to-right line.
* @param x_pos The x offset (in Pango::GlyphUnit)
* from the left edge of the line.
* @param index Location to store calculated byte index for
* the grapheme in which the user clicked.
* @param trailing Location to store a integer indicating where
* in the grapheme the user clicked. It will either
* be zero, or the number of characters in the
* grapheme. 0 represents the trailing edge of the grapheme.
* @return <tt>false</tt> if @a x_pos was outside the line, <tt>true</tt> if inside.
*/
bool x_to_index(int x_pos, int& index, int& trailing) const;
/** Converts an index within a line to a @a x position.
* @param index Byte offset of a grapheme within the layout.
* @param trailing A boolean indicating the edge of the grapheme to retrieve the position of. If <tt>false</tt>, the trailing edge of the grapheme, if <tt>true</tt> the leading of the grapheme.
* @return The x offset (in thousands of a device unit).
*/
int index_to_x(int index, bool trailing) const;
/** Get a list of visual ranges corresponding to a given logical range.
* This list is not necessarily minimal - there may be consecutive ranges which are adjacent.
* The ranges will be sorted from left to right. The ranges are with respect to the
* left edge of the entire layout, not with respect to the line.
* @param start_index The start byte index of the logical range.
* If the value of @a start_index is less than the start index for the line,
* then the first range will extend all the way to the leading edge of the layout.
* Otherwise it will start at the leading edge of the first character.
* @param end_index The end byte index of the logical range.
* If the value of @a end_index is greater than the end index for the line,
* then the last range will extend all the way to the trailing edge of the layout.
* Otherwise, it will end at the trailing edge of the last character.
* @return An array of ranges represented by pairs of integers marking the start and end pixel coordinates of the ranges.
*/
Glib::ArrayHandle<std::pair<int,int> > get_x_ranges(int start_index, int end_index) const;
/** Compute the logical and ink extents of a layout line. See the documentation
* for Pango::Font::get_glyph_extents() for details about the interpretation
* of the rectangles.
* @param ink_rect Rectangle used to store the extents of the glyph string as drawn.
* @param logical_rect Rectangle used to store the logical extents of the glyph string.
*/
void get_extents(Rectangle& ink_rect, Rectangle& logical_rect) const;
/** Compute the ink extents of a layout line.
* @return The extents of the layout line as drawn.
*/
Rectangle get_ink_extents() const;
/** Compute the logical extents of a layout line.
* @return The logical extents of the layout line.
*/
Rectangle get_logical_extents() const;
/** Compute the logical and ink extents of a layout line. See the documentation
* for Pango::Font::get_glyph_extents() for details about the interpretation
* of the rectangles. The returned rectangles are in device units, as
* opposed to pango_layout_line_get_extents(), which returns the extents in
* units of device unit / PANGO_SCALE.
* @param ink_rect Rectangle used to store the extents of the glyph string as drawn.
* @param logical_rect Rectangle used to store the logical extents of the glyph string.
*/
void get_pixel_extents(Rectangle& ink_rect, Rectangle& logical_rect) const;
/** Compute the ink extents of a layout line in device units.
* @return The extents of the layout line as drawn.
*/
Rectangle get_pixel_ink_extents() const;
/** Compute the logical extents of a layout line in device units.
* @return The logical extents of the layout line.
*/
Rectangle get_pixel_logical_extents() const;
Glib::RefPtr<Pango::Layout> get_layout();
Glib::RefPtr<const Pango::Layout> get_layout() const;
//_MEMBER_SET_GOBJECT(layout, layout, Pango::Layout, PangoLayout*)
int get_length() const;
int get_start_index() const;
};
} // namespace Pango
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
// forward declaration needed by LayoutLineTraits
Glib::RefPtr<Pango::LayoutLine> wrap(PangoLayoutLine* object, bool take_copy /* = false */);
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Pango
{
struct LayoutLineTraits
{
typedef Glib::RefPtr<LayoutLine> CppType;
typedef PangoLayoutLine * CType;
typedef PangoLayoutLine * CTypeNonConst;
static CType to_c_type (const CppType& ptr) { return Glib::unwrap(ptr); }
static CType to_c_type (CType ptr) { return ptr; }
static CppType to_cpp_type (CType ptr) { return Glib::wrap(ptr, true); }
static void release_c_type (CType ptr) { pango_layout_line_unref(ptr); }
};
typedef Glib::SListHandle< Glib::RefPtr<LayoutLine>, LayoutLineTraits > SListHandle_LayoutLine;
typedef Glib::SListHandle< Glib::RefPtr<const LayoutLine>, LayoutLineTraits > SListHandle_ConstLayoutLine;
} // namespace Pango
namespace Glib
{
/** @relates Pango::LayoutLine
* @param object The C instance
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*/
Glib::RefPtr<Pango::LayoutLine> wrap(PangoLayoutLine* object, bool take_copy = false);
} // namespace Glib
#endif /* _PANGOMM_LAYOUTLINE_H */
|
