Gtk::StockID Class Reference

#include <stockid.h>

Public Member Functions
	StockID ()
	StockID (const BuiltinStockID &id)
	StockID (const Glib::ustring &id)
	StockID (const char *id)
	~StockID ()
	StockID (const StockID &other)
StockID &	operator= (const StockID &other)
	operator bool () const
bool	equal (const StockID &rhs) const
Glib::ustring	get_string () const
const char *	get_c_str () const

Protected Attributes
Glib::ustring	id_

Related Functions
(Note that these are not member functions.)
bool	operator== (const StockID &lhs, const StockID &rhs)
bool	operator!= (const StockID &lhs, const StockID &rhs)

Detailed Description

See also Gtk::BuiltinStockID.

Definition at line 42 of file stockid.h.

Constructor & Destructor Documentation

StockID() [1/5]

Gtk::StockID::StockID

(

)

Create an empty StockID

StockID() [2/5]

Gtk::StockID::StockID

(

const BuiltinStockID &

id

)

Create a StockID from one of the build-in stock ids.

See also Gtk::BuildinStockID.

StockID() [3/5]

Gtk::StockID::StockID ( const Glib::ustring &  id )

explicit

Create a StockID from its string representation.

Parameters

id	string representation of the stock id. Usually something like "gtk-about".

StockID() [4/5]

Gtk::StockID::StockID ( const char *  id )

explicit

Create a StockID from its string representation.

Parameters

id	string representation of the stock id. Usually something like "gtk-about".

If id is 0 an empty StockID will be created.

~StockID()

Gtk::StockID::~StockID

(

)

StockID() [5/5]

Gtk::StockID::StockID

(

const StockID &

other

)

Create a StockID as copy from another.

Parameters

other

StockID to copy.

Member Function Documentation

equal()

bool Gtk::StockID::equal

(

const StockID &

rhs

)

const

Check if two StockIDs are equal.

Parameters

rhs	Another StockID.

Returns

true if both ids equal - false otherwise.

get_c_str()

const char* Gtk::StockID::get_c_str

(

)

const

Get the string representation as a const gchar*.

Returns

string representation as const gchar*.

get_string()

Glib::ustring Gtk::StockID::get_string

(

)

const

Get the string representation of the StockID.

Returns

something like "gtk-about".

operator bool()

Gtk::StockID::operator bool

(

)

const

Tests whether the StockID is not empty.

operator=()

StockID& Gtk::StockID::operator=

(

const StockID &

other

)

Check if the StockIDs are equal.

Parameters

other

Another StockID.

Friends And Related Function Documentation

operator!=()

bool operator!= ( const StockID &  lhs, const StockID &  rhs  )

related

Definition at line 110 of file stockid.h.

operator==()

bool operator== ( const StockID &  lhs, const StockID &  rhs  )

related

Definition at line 106 of file stockid.h.

Member Data Documentation

id_

Glib::ustring Gtk::StockID::id_

protected

Definition at line 102 of file stockid.h.

---

The documentation for this class was generated from the following file:

• stockid.h