/usr/include/pangomm-1.4/pangomm/context.h is in libpangomm-1.4-dev 2.34.0-1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 | // -*- c++ -*-
// Generated by gtkmmproc -- DO NOT MODIFY!
#ifndef _PANGOMM_CONTEXT_H
#define _PANGOMM_CONTEXT_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
/* $Id: context.hg,v 1.7 2006/06/10 15:26:24 murrayc Exp $ */
/* context.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 Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser 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/object.h>
#include <glibmm/arrayhandle.h>
#include <glibmm/listhandle.h>
#include <pangomm/fontdescription.h>
#include <pangomm/fontmetrics.h>
#include <pangomm/fontset.h>
#include <pangomm/fontmap.h>
#include <pangomm/item.h>
#include <pangomm/attrlist.h>
#include <pangomm/types.h> //For Matrix
#include <pango/pango-context.h>
#include <cairomm/context.h>
#include <cairomm/fontoptions.h>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _PangoContext PangoContext;
typedef struct _PangoContextClass PangoContextClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Pango
{ class Context_Class; } // namespace Pango
namespace Pango
{
/** @addtogroup pangommEnums pangomm Enums and Flags */
/**
*
* @ingroup pangommEnums
*/
enum Direction
{
DIRECTION_LTR,
DIRECTION_RTL,
DIRECTION_TTB_LTR,
DIRECTION_TTB_RTL,
DIRECTION_WEAK_LTR,
DIRECTION_WEAK_RTL,
DIRECTION_NEUTRAL
};
} // namespace Pango
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
template <>
class Value<Pango::Direction> : public Glib::Value_Enum<Pango::Direction>
{
public:
static GType value_type() G_GNUC_CONST;
};
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Pango
{
/**
*
* @ingroup pangommEnums
*/
enum GravityHint
{
GRAVITY_HINT_NATURAL,
GRAVITY_HINT_STRONG,
GRAVITY_HINT_LINE
};
} // namespace Pango
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
template <>
class Value<Pango::GravityHint> : public Glib::Value_Enum<Pango::GravityHint>
{
public:
static GType value_type() G_GNUC_CONST;
};
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Pango
{
/** A Pango::Context stores global information used to control the itemization process.
* You can retrieve a Pango::Context object with Gtk::Widget::create_pango_context() or
* Gtk::Widget::get_pango_context(). If you don't use gtkmm call some c function of the
* pango backend you intend to use and create a wrapper for the returned context,
* e.g. Glib::wrap(pango_x_get_context()).
*
* Creating a Pango::Context object is the starting point of every rendering process.
* You can either use it to create a high level Pango::Layout object which does all
* the hard work for you by passing it into
* Pango::Layout::create() or to generate glyph strings from character strings with
* the help of itemize() and Pango::Item::shape() subsequently.
*
* Which fonts are used for rendering can be influenced by setting the default
* font description, language and base direction of the context.
*
* If you want to calculate the space some text will need to be displayed you
* might find the functions of Pango::FontMetrics useful. Use get_metrics() to
* obtain the Pango::FontMetrics object for a specific Pango::FontDescription.
* For more detailed calculations in a rendering-system-independant manner
* and to determine whether specific characters can be represented by the
* font that would be used for a specific Pango::FontDescription load a
* Pango::Fontset with load_fontset() (load_font() returns the Pango::Font
* that is the closest match for a Pango::FontDescription; however that's not
* necessarily the font that will be used for rendering).
*/
class Context : public Glib::Object
{
#ifndef DOXYGEN_SHOULD_SKIP_THIS
public:
typedef Context CppObjectType;
typedef Context_Class CppClassType;
typedef PangoContext BaseObjectType;
typedef PangoContextClass BaseClassType;
private: friend class Context_Class;
static CppClassType context_class_;
private:
// noncopyable
Context(const Context&);
Context& operator=(const Context&);
protected:
explicit Context(const Glib::ConstructParams& construct_params);
explicit Context(PangoContext* castitem);
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
public:
virtual ~Context();
/** Get the GType for this class, for use with the underlying GObject type system.
*/
static GType get_type() G_GNUC_CONST;
#ifndef DOXYGEN_SHOULD_SKIP_THIS
static GType get_base_type() G_GNUC_CONST;
#endif
///Provides access to the underlying C GObject.
PangoContext* gobj() { return reinterpret_cast<PangoContext*>(gobject_); }
///Provides access to the underlying C GObject.
const PangoContext* gobj() const { return reinterpret_cast<PangoContext*>(gobject_); }
///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
PangoContext* gobj_copy();
private:
//PANGO_ENABLE_BACKEND
protected:
Context();
public:
/** List all available font families for a context.
* You can specify one of these as your desired font family in the Pango::FontDesciption
* objects you use, e.g. in the default font description of the context.
* @return An array of Pango::FontFamily objects.
*/
Glib::ArrayHandle< Glib::RefPtr<FontFamily> > list_families() const;
/** Sets the font map to be searched when fonts are looked-up in this context.
* This is only for internal use by Pango backends, a Pango::Context obtained
* via one of the recommended methods should already have a suitable font map.
* @param font_map The Pango::FontMap to set.
*/
void set_font_map(const Glib::RefPtr<FontMap>& font_map);
/** Gets the Pango::Fontmap used to look up fonts for this context.
*
* @newin{1,6}
* @return The font map for the Pango::Context. This value
* is owned by Pango and should not be unreferenced.
*/
Glib::RefPtr<FontMap> get_font_map();
/** Gets the Pango::Fontmap used to look up fonts for this context.
*
* @newin{1,6}
* @return The font map for the Pango::Context. This value
* is owned by Pango and should not be unreferenced.
*/
Glib::RefPtr<const FontMap> get_font_map() const;
/** Loads the font in one of the fontmaps in the context
* that is the closest match for @a desc.
* @param desc A Pango::FontDescription describing the font to load.
* @return The font loaded, or <tt>0</tt> if no font matched.
*/
Glib::RefPtr<Font> load_font(const FontDescription& desc) const;
/** Load a set of fonts in the context that can be used to render
* a font matching @a desc.
* @param desc A Pango::FontDescription describing the fonts to load.
* @param language A Pango::Language the fonts will be used for.
* @return The fontset, or <tt>0</tt> if no font matched.
*/
Glib::RefPtr<Fontset> load_fontset(const FontDescription& desc, const Language& language) const;
/** Get overall metric information for a particular font description.
* The metrics may be substantially different for different scripts. However this
* function overload returns the metrics of the entire font.
* @param desc A Pango::FontDescription object.
* @return A Pango::FontMetrics object.
*/
FontMetrics get_metrics(const FontDescription& desc) const;
/** Get overall metric information for a font particular font
* description. Since the metrics may be substantially different for
* different scripts, a language tag can be provided to indicate that
* the metrics should be retrieved that correspond to the script(s)
* used by that language.
*
* The Pango::FontDescription is interpreted in the same way as
* by pango_itemize(), and the family name may be a comma separated
* list of figures. If characters from multiple of these families
* would be used to render the string, then the returned fonts would
* be a composite of the metrics for the fonts loaded for the
* individual families.
* @param desc A Pango::FontDescription structure.
* @param language Language tag used to determine which script to get the metrics
* for.
* @return A Pango::Metrics object.
*/
FontMetrics get_metrics(const FontDescription& desc, const Language& language) const;
/** Set the default font description for the context
* @param desc The new pango font description.
*/
void set_font_description(const FontDescription& desc);
/** Retrieve the default font description for the context.
* @return A pointer to the context's default font description.
* This value must not be modified or freed.
*/
FontDescription get_font_description() const;
/** Retrieves the global language tag for the context.
* @return The global language tag.
*/
Language get_language() const;
/** Sets the global language tag for the context. The default language
* for the locale of the running process can be found using
* Pango::Language::get_default().
* @param language The new language tag.
*/
void set_language(const Language& language);
/** Sets the base direction for the context.
*
* The base direction is used in applying the Unicode bidirectional
* algorithm; if the @a direction is Pango::DIRECTION_LTR or
* Pango::DIRECTION_RTL, then the value will be used as the paragraph
* direction in the Unicode bidirectional algorithm. A value of
* Pango::DIRECTION_WEAK_LTR or Pango::DIRECTION_WEAK_RTL is used only
* for paragraphs that do not contain any strong characters themselves.
* @param direction The new base direction.
*/
void set_base_dir(Direction direction);
/** Retrieves the base direction for the context. See
* set_base_dir().
* @return The base direction for the context.
*/
Direction get_base_dir() const;
/** Sets the base gravity for the context.
*
* The base gravity is used in laying vertical text out.
*
* @newin{1,16}
* @param gravity The new base gravity.
*/
void set_base_gravity(Gravity gravity);
/** Retrieves the base gravity for the context. See
* set_base_gravity().
*
* @newin{1,16}
* @return The base gravity for the context.
*/
Gravity get_base_gravity() const;
/** Retrieves the gravity for the context. This is similar to
* get_base_gravity(), except for when the base gravity
* is Pango::GRAVITY_AUTO for which pango_gravity_get_for_matrix() is used
* to return the gravity from the current context matrix.
*
* @newin{1,16}
* @return The resolved gravity for the context.
*/
Gravity get_gravity() const;
/** Sets the gravity hint for the context.
*
* The gravity hint is used in laying vertical text out, and is only relevant
* if gravity of the context as returned by get_gravity()
* is set Pango::GRAVITY_EAST or Pango::GRAVITY_WEST.
*
* @newin{1,16}
* @param hint The new gravity hint.
*/
void set_gravity_hint(GravityHint hint);
/** Retrieves the gravity hint for the context. See
* set_gravity_hint() for details.
*
* @newin{1,16}
* @return The gravity hint for the context.
*/
GravityHint get_gravity_hint() const;
/** Sets the transformation matrix that will be applied when rendering
* with this context. Note that reported metrics are in the user space
* coordinates before the application of the matrix, not device-space
* coordinates after the application of the matrix. So, they don't scale
* with the matrix, though they may change slightly for different
* matrices, depending on how the text is fit to the pixel grid.
*
* @newin{1,6}
* @param matrix A Pango::Matrix, or <tt>0</tt> to unset any existing matrix.
* (No matrix set is the same as setting the identity matrix.).
*/
void set_matrix(const Matrix& matrix);
Matrix get_matrix() const;
/** Breaks a piece of text into segments with consistent directional level and shaping engine.
* Each byte of @a text will be contained in exactly one of the items in the returned list.
* The generated list of items will be in logical order (the start offsets of the items
* are ascending).
* @param text The text to itemize.
* @param attrs The set of attributes that apply.
* @return A list of Pango::Item objects.
*/
ListHandle_Item itemize(const Glib::ustring& text, const AttrList& attrs) const;
/** Breaks a piece of text into segments with consistent directional level and shaping engine.
* Each byte of @a text will be contained in exactly one of the items in the returned list.
* The generated list of items will be in logical order (the start offsets of the items
* are ascending).
*
* @a cached_iter should be an iterator over @a attrs currently positioned at a range before
* or containing @a start_index. @a cached_iter will be advanced to the range covering the
* position just after @a start_index + @a length. (i.e. if itemizing in a loop, just keep
* passing in the same @a cached_iter).
*
* @param text The text to itemize.
* @param start_index First byte in @a text to process.
* @param length The number of bytes (not characters) to process after @a start_index. This must be >= <tt>0</tt>.
* @param attrs The set of attributes that apply to @a text.
* @param cached_iter Cached attribute iterator.
* @return A list of Pango::Item structures.
*/
ListHandle_Item itemize(const Glib::ustring& text, int start_index, int length,
const AttrList& attrs, AttrIter& cached_iter) const;
/** Updates a Pango Context previously created for use with Cairo to
* match the current transformation and target surface of a Cairo
* Context. If any layouts have been created for the context,
* it's necessary to call Pango::Layout::context_changed() on those
* layouts.
*
* @param context A Cairo context, from CairoFontMap::create_context().
*/
void update_from_cairo_context(const Cairo::RefPtr<Cairo::Context>& context);
/** Sets the font options used when rendering text with this context.
* These options override any options that pango_cairo_update_context()
* derives from the target surface.
*
* @newin{1,10}
* @param context A Pango::Context, from a pangocairo font map.
* @param options A #cairo_font_options_t, or <tt>0</tt> to unset any previously set
* options. A copy is made.
*/
void set_cairo_font_options(const Cairo::FontOptions& options);
/** Retrieves any font rendering options previously set with
* pango_cairo_font_map_set_font_options(). This function does not report options
* that are derived from the target surface by pango_cairo_update_context()
*
* @newin{1,10}
* @param context A Pango::Context, from a pangocairo font map.
* @return The font options previously set on the context, or <tt>0</tt>
* if no options have been set. This value is owned by the context
* and must not be modified or freed.
*/
Cairo::FontOptions get_font_options() const;
/** Sets the resolution for the context. This is a scale factor between
* points specified in a Pango::FontDescription and Cairo units. The
* default value is 96, meaning that a 10 point font will be 13
* units high. (10 * 96. / 72. = 13.3).
*
* @newin{1,10}
* @param context A Pango::Context, from a pangocairo font map.
* @param dpi The resolution in "dots per inch". (Physical inches aren't actually
* involved; the terminology is conventional.) A 0 or negative value
* means to use the resolution from the font map.
*/
void set_resolution(double dpi);
/** Gets the resolution for the context. See pango_cairo_context_set_resolution()
*
* @newin{1,10}
* @param context A Pango::Context, from a pangocairo font map.
* @return The resolution in "dots per inch". A negative value will
* be returned if no resolution has previously been set.
*/
double get_resolution() const;
public:
public:
//C++ methods used to invoke GTK+ virtual functions:
protected:
//GTK+ Virtual Functions (override these to change behaviour):
//Default Signal Handlers::
};
} /* namespace Pango */
namespace Glib
{
/** A Glib::wrap() method for this object.
*
* @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.
*
* @relates Pango::Context
*/
Glib::RefPtr<Pango::Context> wrap(PangoContext* object, bool take_copy = false);
}
#endif /* _PANGOMM_CONTEXT_H */
|