pangomm: Pango::Attribute Class Reference
The Pango::Attribute structure represents the common portions of all attributes. More...
#include <pangomm/attributes.h>
Public Member Functions | |
Attribute () | |
Constructs an invalid attribute. More... | |
Attribute (const Attribute& src) | |
Attribute (PangoAttribute* castitem, bool take_copy=true) | |
~Attribute () | |
Attribute& | operator= (const Attribute& src) |
AttrType | get_type () const |
Gets the type ID for this attribute. More... | |
unsigned int | get_start_index () const |
Gets the start index of the range. More... | |
unsigned int | get_end_index () const |
Gets the end index of the range. More... | |
void | set_start_index (const unsigned int& value) |
Sets the start index of the range. More... | |
void | set_end_index (const unsigned int& value) |
Sets the end index of the range. More... | |
bool | equal (const Attribute& attr2) const |
Compare two attributes for equality. More... | |
PangoAttribute* | gobj () |
Provides access to the underlying C GObject. More... | |
const PangoAttribute* | gobj () const |
Provides access to the underlying C GObject. More... | |
Static Public Member Functions | |
static AttrType | register_type (const Glib::ustring& name) |
Allocate a new attribute type ID. More... | |
static Glib::ustring | get_type_name (AttrType type) |
Fetches the attribute type name passed in when registering the type using register_type(). More... | |
static AttrString | create_attr_family (const Glib::ustring& family) |
Create a new font family attribute. More... | |
static AttrLanguage | create_attr_language (const Language& language) |
Create a new language tag attribute. More... | |
static AttrColor | create_attr_foreground (guint16 red, guint16 green, guint16 blue) |
Create a new foreground color attribute. More... | |
static AttrColor | create_attr_background (guint16 red, guint16 green, guint16 blue) |
Create a new background color attribute. More... | |
static AttrInt | create_attr_foreground_alpha (guint16 alpha) |
Create a new foreground alpha attribute. More... | |
static AttrInt | create_attr_background_alpha (guint16 alpha) |
Create a new background alpha attribute. More... | |
static AttrInt | create_attr_size (int size) |
Create a new font-size attribute. More... | |
static AttrInt | create_attr_size_absolute (int size) |
Create a new font-size attribute. More... | |
static AttrInt | create_attr_style (Style style) |
Create a new font slant style attribute. More... | |
static AttrInt | create_attr_weight (Weight weight) |
Create a new font weight attribute. More... | |
static AttrInt | create_attr_variant (Variant variant) |
Create a new font variant attribute (normal or small caps). More... | |
static AttrInt | create_attr_stretch (Stretch stretch) |
Create a new font stretch attribute. More... | |
static AttrFontDesc | create_attr_font_desc (const FontDescription& desc) |
Create a new font description attribute. More... | |
static AttrInt | create_attr_underline (Underline underline) |
Create a new underline-style object. More... | |
static AttrColor | create_attr_underline_color (guint16 red, guint16 green, guint16 blue) |
Create a new underline color attribute. More... | |
static AttrInt | create_attr_overline (Overline overline) |
Create a new overline-style object. More... | |
static AttrColor | create_attr_overline_color (guint16 red, guint16 green, guint16 blue) |
Create a new overline color attribute. More... | |
static AttrInt | create_attr_strikethrough (bool strikethrough) |
Create a new font strike-through attribute. More... | |
static AttrColor | create_attr_strikethrough_color (guint16 red, guint16 green, guint16 blue) |
Create a new strikethrough color attribute. More... | |
static AttrInt | create_attr_rise (int rise) |
Create a new baseline displacement attribute. More... | |
static AttrFloat | create_attr_scale (double scale_factor) |
Create a new font size scale attribute. More... | |
static AttrInt | create_attr_fallback (bool enable_fallback) |
Create a new font fallback attribute. More... | |
static AttrInt | create_attr_letter_spacing (int letter_spacing) |
Create a new letter-spacing attribute. More... | |
static AttrShape | create_attr_shape (const Rectangle& ink_rect, const Rectangle& logical_rect) |
Create a new shape attribute. More... | |
static AttrInt | create_attr_gravity (Gravity gravity) |
Create a new gravity attribute. More... | |
static AttrInt | create_attr_gravity_hint (GravityHint hint) |
Create a new gravity hint attribute. More... | |
static AttrString | create_attr_font_features (const Glib::ustring& features) |
Create a new font features tag attribute. More... | |
static AttrInt | create_attr_allow_breaks (bool allow_breaks) |
Create a new allow-breaks attribute. More... | |
static AttrInt | create_attr_insert_hyphens (bool insert_hyphens) |
Create a new insert-hyphens attribute. More... | |
static AttrInt | create_attr_show (ShowFlags show) |
Create a new attribute that influences how invisible characters are rendered. More... | |
Protected Attributes | |
PangoAttribute* | gobject_ |
Related Functions | |
(Note that these are not member functions.) | |
bool | operator== (const Attribute& lhs, const Attribute& rhs) |
bool | operator!= (const Attribute& lhs, const Attribute& rhs) |
Pango::Attribute | wrap (PangoAttribute* object, bool take_copy=false) |
Detailed Description
The Pango::Attribute structure represents the common portions of all attributes.
Particular types of attributes derive this class. It holds the range in which the value in the type-specific part of the attribute applies.
Attributed text is used in a number of places in pango. It is used as the input to the itemization process and also when creating a Pango::Layout.
Constructor & Destructor Documentation
Pango::Attribute::Attribute | ( | ) |
Constructs an invalid attribute.
Pango::Attribute::Attribute | ( | const Attribute& | src | ) |
|
explicit |
Pango::Attribute::~Attribute | ( | ) |
Member Function Documentation
|
static |
Create a new allow-breaks attribute.
If breaks are disabled, the range will be kept in a single run, as far as possible.
- Parameters
-
allow_breaks true
if line breaks are allowed.
- Returns
- An attribute of type AttrInt.
|
static |
Create a new background color attribute.
- Parameters
-
red The red value (ranging from 0 to 65535). green The green value (ranging from 0 to 65535). blue The blue value (ranging from 0 to 65535).
- Returns
- An attribute of type AttrColor.
|
static |
Create a new background alpha attribute.
- Parameters
-
alpha The alpha value, between 1 and 65536.
|
static |
Create a new font fallback attribute.
If fallback is disabled, characters will only be used from the closest matching font on the system. No fallback will be done to other fonts on the system that might contain the characters in the text.
- Parameters
-
enable_fallback true
if we should fall back on other fonts for characters the active font is missing.
- Returns
- An attribute of type AttrInt.
|
static |
Create a new font family attribute.
- Parameters
-
family The family or comma separated list of families.
- Returns
- An attribute of type AttrString.
|
static |
Create a new font description attribute.
This attribute allows setting family, style, weight, variant, stretch, and size simultaneously.
- Parameters
-
desc The font description.
- Returns
- An attribute of type AttrFontDesc.
|
static |
Create a new font features tag attribute.
- Parameters
-
features A string with OpenType font features, in CSS syntax.
- Returns
- An attribute of type AttrString.
|
static |
Create a new foreground color attribute.
- Parameters
-
red The red value (ranging from 0 to 65535). green The green value (ranging from 0 to 65535). blue The blue value (ranging from 0 to 65535).
- Returns
- An attribute of type AttrColor.
|
static |
Create a new foreground alpha attribute.
- Parameters
-
alpha The alpha value, between 1 and 65536.
Create a new gravity attribute.
- Parameters
-
gravity The gravity value; should not be Pango::Gravity::AUTO.
- Returns
- An attribute of type AttrInt.
|
static |
Create a new gravity hint attribute.
- Parameters
-
hint The gravity hint value.
- Returns
- An attribute of type AttrInt.
|
static |
Create a new insert-hyphens attribute.
Pangomm will insert hyphens when breaking lines in the middle of a word. This attribute can be used to suppress the hyphen.
- Parameters
-
insert_hyphens true
if hyphens should be inserted.
- Returns
- An attribute of type AttrInt.
|
static |
Create a new language tag attribute.
- Parameters
-
language The language tag.
- Returns
- An attribute of type AttrLanguage.
|
static |
Create a new overline-style object.
- Parameters
-
overline The overline style.
- Returns
- An attribute of type AttrInt.
|
static |
Create a new overline color attribute.
This attribute modifies the color of overlines. If not set, overlines will use the foreground color.
- Parameters
-
red The red value (ranging from 0 to 65535). green The green value (ranging from 0 to 65535). blue The blue value (ranging from 0 to 65535).
- Returns
- An attribute of type AttrColor.
|
static |
Create a new baseline displacement attribute.
- Parameters
-
rise The amount that the text should be displaced vertically, in 10'000ths of an em. Positive values displace the text upwards.
- Returns
- An attribute of type AttrInt.
|
static |
Create a new font size scale attribute.
The base font for the affected text will have its size multiplied by scale_factor.
- Parameters
-
scale_factor Factor to scale the font.
- Returns
- An attribute of type AttrFloat.
|
static |
Create a new shape attribute.
A shape is used to impose a particular ink and logical rect on the result of shaping a particular glyph. This might be used, for instance, for embedding a picture or a widget inside a PangoLayout.
- Parameters
-
ink_rect Ink rectangle to assign to each character. logical_rect Logical rectangle assign to each character.
- Returns
- An attribute of type AttrShape.
Create a new attribute that influences how invisible characters are rendered.
- Parameters
-
flags Pango::ShowFlags to apply.
- Returns
- An attribute of type AttrInt.
|
static |
Create a new font-size attribute.
- Parameters
-
size The font size, in 1024ths of a point.
- Returns
- An attribute of type AttrInt.
|
static |
Create a new font-size attribute.
- Parameters
-
size The font size, in 1024ths of a device unit.
- Returns
- An attribute of type AttrInt.
Create a new font stretch attribute.
- Parameters
-
stretch The stretch.
- Returns
- An attribute of type AttrInt.
|
static |
Create a new font strike-through attribute.
- Parameters
-
strikethrough True indicates the text should be struck-through.
- Returns
- An attribute of type AttrInt.
|
static |
Create a new strikethrough color attribute.
This attribute modifies the color of strikethrough lines. If not set, strikethrough lines will use the foreground color.
- Parameters
-
red The red value (ranging from 0 to 65535). green The green value (ranging from 0 to 65535). blue The blue value (ranging from 0 to 65535).
- Returns
- An attribute of type AttrColor.
Create a new font slant style attribute.
- Parameters
-
style The slant style.
- Returns
- An attribute of type AttrInt.
Create a new underline-style object.
- Parameters
-
underline The underline style.
- Returns
- An attribute of type AttrInt.
|
static |
Create a new underline color attribute.
This attribute modifies the color of underlines. If not set, underlines will use the foreground color.
- Parameters
-
red The red value (ranging from 0 to 65535). green The green value (ranging from 0 to 65535). blue The blue value (ranging from 0 to 65535).
- Returns
- An attribute of type AttrColor.
Create a new font variant attribute (normal or small caps).
- Parameters
-
variant The variant.
- Returns
- An attribute of type AttrInt.
Create a new font weight attribute.
- Parameters
-
weight The weight.
- Returns
- An attribute of type AttrInt.
bool Pango::Attribute::equal | ( | const Attribute& | attr2 | ) | const |
Compare two attributes for equality.
This compares only the actual value of the two attributes and not the ranges that the attributes apply to.
- Parameters
-
attr2 Another Pango::Attribute.
- Returns
true
if the two attributes have the same value.
unsigned int Pango::Attribute::get_end_index | ( | ) | const |
Gets the end index of the range.
The character at this index is not included in the range.
- Returns
- The end index of the range.
unsigned int Pango::Attribute::get_start_index | ( | ) | const |
Gets the start index of the range.
- Returns
- The start index of the range.
AttrType Pango::Attribute::get_type | ( | ) | const |
Gets the type ID for this attribute.
- Returns
- The type ID for this attribute or ATTR_INVALID if the attribute is invalid.
|
static |
Fetches the attribute type name passed in when registering the type using register_type().
- Parameters
-
type An attribute type ID to fetch the name for.
- Returns
- The type ID name (which may be an empty string), or an empty string if type is a built-in Pango attribute type or invalid.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
|
static |
Allocate a new attribute type ID.
The attribute type name can be accessed later by using get_type_name().
- Parameters
-
name An identifier for the type.
- Returns
- The new type ID.
void Pango::Attribute::set_end_index | ( | const unsigned int & | value | ) |
Sets the end index of the range.
The character at this index is not included in the range.
- Parameters
-
value The new end index (in bytes).
void Pango::Attribute::set_start_index | ( | const unsigned int & | value | ) |
Sets the start index of the range.
- Parameters
-
value The new start index (in bytes).
Friends And Related Function Documentation
|
related |
Member Data Documentation
|
protected |