pangomm  2.41.5
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Pango::Coverage Class Referencefinal

A Pango::Coverage represents a map from ISO-10646 character point to Pango::Level. More...

#include <pangomm/coverage.h>

Public Types

enum  Level {
  Level::NONE,
  Level::FALLBACK,
  Level::APPROXIMATE,
  Level::EXACT
}
 Used to indicate how well a font can represent a particular Unicode character point for a particular script. More...
 

Public Member Functions

void reference () const
 Increment the reference count for this object. More...
 
void unreference () const
 Decrement the reference count for this object. More...
 
PangoCoverage* gobj ()
 Provides access to the underlying C instance. More...
 
const PangoCoverage* gobj () const
 Provides access to the underlying C instance. More...
 
PangoCoverage* gobj_copy () const
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
 Coverage ()=delete
 
 Coverage (const Coverage&)=delete
 
Coverageoperator= (const Coverage&)=delete
 
Level get (int index) const
 Determine whether a particular index is covered by coverage. More...
 
void set (int index, Level level)
 Modify a particular index within coverage. More...
 
void max (const Glib::RefPtr< Coverage >& other) const
 Set the coverage for each index in coverage to be the max (better) value of the current coverage for the index and the coverage for the corresponding index in other. More...
 
std::vector< unsigned char > to_bytes () const
 Convert the coverage map into a flat binary format. More...
 

Static Public Member Functions

static Glib::RefPtr< Coveragecreate ()
 
static Glib::RefPtr< Coveragecreate (const guchar* bytes, int n_bytes)
 Convert data generated from to_bytes() back to a Pango::Coverage. More...
 

Protected Member Functions

void operator delete (void*, std::size_t)
 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Pango::Coveragewrap (PangoCoverage* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Detailed Description

A Pango::Coverage represents a map from ISO-10646 character point to Pango::Level.

It is often necessary in pango to determine if a particular font can represent a particular character, and also how well it can represent that character. Pango::Coverage holds this information.

Constructor & Destructor Documentation

◆ Coverage() [1/2]

Pango::Coverage::Coverage ( )
delete

◆ Coverage() [2/2]

Pango::Coverage::Coverage ( const Coverage )
delete

Member Function Documentation

◆ create() [1/2]

static Glib::RefPtr<Coverage> Pango::Coverage::create ( )
static

◆ create() [2/2]

static Glib::RefPtr<Coverage> Pango::Coverage::create ( const guchar *  bytes,
int  n_bytes 
)
static

Convert data generated from to_bytes() back to a Pango::Coverage.

Parameters
bytesBinary data representing a Pango::Coverage.
n_bytesThe size of bytes in bytes.
Returns
A newly allocated Pango::Coverage, or nullptr if the data was invalid.

◆ get()

Level Pango::Coverage::get ( int  index) const

Determine whether a particular index is covered by coverage.

Parameters
indexThe index to check.
Returns
The coverage level of coverage for character index.

◆ gobj() [1/2]

PangoCoverage* Pango::Coverage::gobj ( )

Provides access to the underlying C instance.

◆ gobj() [2/2]

const PangoCoverage* Pango::Coverage::gobj ( ) const

Provides access to the underlying C instance.

◆ gobj_copy()

PangoCoverage* Pango::Coverage::gobj_copy ( ) const

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

◆ max()

void Pango::Coverage::max ( const Glib::RefPtr< Coverage >&  other) const

Set the coverage for each index in coverage to be the max (better) value of the current coverage for the index and the coverage for the corresponding index in other.

Parameters
otherAnother Pango::Coverage.

◆ operator delete()

void Pango::Coverage::operator delete ( void *  ,
std::size_t   
)
protected

◆ operator=()

Coverage& Pango::Coverage::operator= ( const Coverage )
delete

◆ reference()

void Pango::Coverage::reference ( ) const

Increment the reference count for this object.

You should never need to do this manually - use the object via a RefPtr instead.

◆ set()

void Pango::Coverage::set ( int  index,
Level  level 
)

Modify a particular index within coverage.

Parameters
indexThe index to modify.
levelThe new level for index.

◆ to_bytes()

std::vector<unsigned char> Pango::Coverage::to_bytes ( ) const

Convert the coverage map into a flat binary format.

Returns
An array of bytes representing the coverage map.

◆ unreference()

void Pango::Coverage::unreference ( ) const

Decrement the reference count for this object.

You should never need to do this manually - use the object via a RefPtr instead.

Friends And Related Function Documentation

◆ wrap()

Glib::RefPtr< Pango::Coverage > wrap ( PangoCoverage *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns
A C++ instance that wraps this C instance.