gtkmm  4.8.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gdk::ContentFormatsBuilder Class Referencefinal

Helper class for building Gdk::ContentFormats. More...

#include <gdkmm/contentformatsbuilder.h>

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...
 
GdkContentFormatsBuilder * gobj ()
 Provides access to the underlying C instance. More...
 
const GdkContentFormatsBuilder * gobj () const
 Provides access to the underlying C instance. More...
 
GdkContentFormatsBuilder * 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...
 
 ContentFormatsBuilder ()=delete
 
 ContentFormatsBuilder (const ContentFormatsBuilder &)=delete
 
ContentFormatsBuilderoperator= (const ContentFormatsBuilder &)=delete
 
void add_formats (const Glib::RefPtr< const ContentFormats > & formats)
 Appends all formats from formats to builder, skipping those that already exist. More...
 
void add_mime_type (const Glib::ustring & mime_type)
 Appends mime_type to builder if it has not already been added. More...
 
void add_gtype (GType gtype)
 Appends gtype to builder if it has not already been added. More...
 
Glib::RefPtr< ContentFormatsto_formats ()
 Creates a new Gdk::ContentFormats. More...
 

Static Public Member Functions

static Glib::RefPtr< ContentFormatsBuildercreate ()
 Creates a new ContentFormatsBuilder object. More...
 

Protected Member Functions

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

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Gdk::ContentFormatsBuilderwrap (GdkContentFormatsBuilder * object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Detailed Description

Helper class for building Gdk::ContentFormats.

Since gtkmm 3.94:

Constructor & Destructor Documentation

◆ ContentFormatsBuilder() [1/2]

Gdk::ContentFormatsBuilder::ContentFormatsBuilder ( )
delete

◆ ContentFormatsBuilder() [2/2]

Gdk::ContentFormatsBuilder::ContentFormatsBuilder ( const ContentFormatsBuilder )
delete

Member Function Documentation

◆ add_formats()

void Gdk::ContentFormatsBuilder::add_formats ( const Glib::RefPtr< const ContentFormats > &  formats)

Appends all formats from formats to builder, skipping those that already exist.

Parameters
formatsThe formats to add.

◆ add_gtype()

void Gdk::ContentFormatsBuilder::add_gtype ( GType  gtype)

Appends gtype to builder if it has not already been added.

Parameters
gtypeA GType.

◆ add_mime_type()

void Gdk::ContentFormatsBuilder::add_mime_type ( const Glib::ustring &  mime_type)

Appends mime_type to builder if it has not already been added.

Parameters
mime_typeA mime type.

◆ create()

static Glib::RefPtr<ContentFormatsBuilder> Gdk::ContentFormatsBuilder::create ( )
static

Creates a new ContentFormatsBuilder object.

The resulting builder would create an empty ContentFormats. Use addition functions to add types to it.

Returns
A new ContentFormatsBuilder.

◆ gobj() [1/2]

GdkContentFormatsBuilder* Gdk::ContentFormatsBuilder::gobj ( )

Provides access to the underlying C instance.

◆ gobj() [2/2]

const GdkContentFormatsBuilder* Gdk::ContentFormatsBuilder::gobj ( ) const

Provides access to the underlying C instance.

◆ gobj_copy()

GdkContentFormatsBuilder* Gdk::ContentFormatsBuilder::gobj_copy ( ) const

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

◆ operator delete()

void Gdk::ContentFormatsBuilder::operator delete ( void *  ,
std::size_t   
)
protected

◆ operator=()

ContentFormatsBuilder& Gdk::ContentFormatsBuilder::operator= ( const ContentFormatsBuilder )
delete

◆ reference()

void Gdk::ContentFormatsBuilder::reference ( ) const

Increment the reference count for this object.

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

◆ to_formats()

Glib::RefPtr<ContentFormats> Gdk::ContentFormatsBuilder::to_formats ( )

Creates a new Gdk::ContentFormats.

The ContentFormatsBuilder is reset once this function returns; you cannot call this function multiple times on the same builder instance.

Returns
A newly created Gdk::ContentFormats with all the formats added to the builder.

◆ unreference()

void Gdk::ContentFormatsBuilder::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< Gdk::ContentFormatsBuilder > wrap ( GdkContentFormatsBuilder *  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.