gtkmm
3.95.1
|
Functions for handling inter-process communication via selections. More...
#include <gtkmm/selectiondata.h>
Public Member Functions | |
SelectionData () | |
SelectionData (GtkSelectionData* gobject, bool make_a_copy=true) | |
SelectionData (const SelectionData& other) | |
SelectionData& | operator= (const SelectionData& other) |
SelectionData (SelectionData&& other) noexcept | |
SelectionData& | operator= (SelectionData&& other) noexcept |
~SelectionData () noexcept | |
void | swap (SelectionData& other) noexcept |
GtkSelectionData* | gobj () |
Provides access to the underlying C instance. More... | |
const GtkSelectionData* | gobj () const |
Provides access to the underlying C instance. More... | |
GtkSelectionData* | gobj_copy () const |
Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs. More... | |
void | set (int format, const guint8* data, int length) |
Assign a memory block of raw data. More... | |
void | set (const std::string& type, int format, const guint8* data, int length) |
Assign a memory block of raw data. More... | |
void | set (const std::string& type, const std::string& data) |
Assign a string of raw data. More... | |
bool | set_text (const Glib::ustring& data) |
Assign UTF-8 encoded text. More... | |
Glib::ustring | get_text () const |
Gets the contents of the selection data as a UTF-8 string. More... | |
bool | set_pixbuf (const Glib::RefPtr< const Gdk::Pixbuf >& pixbuf) |
Sets the contents of the selection from a Gdk::Pixbuf The pixbuf is converted to the form determined by selection_data->target. More... | |
Glib::RefPtr< Gdk::Pixbuf > | get_pixbuf () const |
Gets the contents of the selection data as a Gdk::Pixbuf. More... | |
bool | set_texture (const Glib::RefPtr< const Gdk::Texture >& texture) |
Sets the contents of the selection from a Gdk::Texture. More... | |
Glib::RefPtr< Gdk::Texture > | get_texture () const |
Gets the contents of the selection data as a Gdk::Pixbuf. More... | |
bool | set_uris (const std::vector< Glib::ustring >& uris) |
Sets the contents of the selection from a list of URIs. More... | |
std::vector< Glib::ustring > | get_uris () const |
Gets the contents of the selection data as a vector of URIs. More... | |
const guchar* | get_data () const |
Retrieves the raw data of the selection. More... | |
int | get_length () const |
Retrieves the length of the raw data of the selection. More... | |
const guchar* | get_data (int& length) const |
Retrieves the raw data of the selection along with its length. More... | |
std::string | get_data_as_string () const |
Retrieves the raw data of the selection as a std::string. More... | |
std::string | get_target () const |
Retrieves the target of the selection. More... | |
std::vector< std::string > | get_targets () const |
See also Gdk::Clipboard::get_formats() More... | |
std::string | get_data_type () const |
Returns the type of the data as set by SelectionData::set(). More... | |
int | get_format () const |
Retrieves the format of the selection. More... | |
Glib::RefPtr< Gdk::Display > | get_display () |
Retrieves the display of the selection. More... | |
Glib::RefPtr< const Gdk::Display > | get_display () const |
Retrieves the display of the selection. More... | |
bool | targets_include_uri () const |
Given a Gtk::SelectionData object holding a list of targets, determines if any of the targets in targets can be used to provide a list or URIs. More... | |
bool | targets_include_text () const |
Given a Gtk::SelectionData object holding a list of targets, determines if any of the targets in targets can be used to provide text. More... | |
bool | targets_include_image (bool writable=true) const |
Given a Gtk::SelectionData object holding a list of targets, determines if any of the targets in targets can be used to provide a Gdk::Pixbuf. More... | |
Static Public Member Functions | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
Protected Attributes | |
GtkSelectionData* | gobject_ |
Related Functions | |
(Note that these are not member functions.) | |
void | swap (SelectionData& lhs, SelectionData& rhs) noexcept |
Gtk::SelectionData | wrap (GtkSelectionData* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Functions for handling inter-process communication via selections.
The selection mechanism provides the basis for different types of communication between processes. In particular, drag and drop works via selections. You will very seldom or never need to use most of the functions in this section directly.
Some of the datatypes defined in this section are used in the drag-and-drop API as well. The Gdk::ContentFormats object represents lists of data types that are supported when sending or receiving data. The Gtk::SelectionData object is used to store a chunk of data along with the data type and other associated information.
Gtk::SelectionData::SelectionData | ( | ) |
|
explicit |
Gtk::SelectionData::SelectionData | ( | const SelectionData& | other | ) |
|
noexcept |
|
noexcept |
const guchar* Gtk::SelectionData::get_data | ( | ) | const |
Retrieves the raw data of the selection.
const guchar* Gtk::SelectionData::get_data | ( | int & | length | ) | const |
Retrieves the raw data of the selection along with its length.
length | Return location for length of the data segment. |
std::string Gtk::SelectionData::get_data_as_string | ( | ) | const |
Retrieves the raw data of the selection as a std::string.
std::string Gtk::SelectionData::get_data_type | ( | ) | const |
Returns the type of the data as set by SelectionData::set().
Glib::RefPtr<Gdk::Display> Gtk::SelectionData::get_display | ( | ) |
Retrieves the display of the selection.
Glib::RefPtr<const Gdk::Display> Gtk::SelectionData::get_display | ( | ) | const |
Retrieves the display of the selection.
int Gtk::SelectionData::get_format | ( | ) | const |
Retrieves the format of the selection.
int Gtk::SelectionData::get_length | ( | ) | const |
Retrieves the length of the raw data of the selection.
Glib::RefPtr<Gdk::Pixbuf> Gtk::SelectionData::get_pixbuf | ( | ) | const |
Gets the contents of the selection data as a Gdk::Pixbuf.
nullptr
. If the result is non-nullptr
it must be freed with Glib::object_unref(). std::string Gtk::SelectionData::get_target | ( | ) | const |
Retrieves the target of the selection.
std::vector<std::string> Gtk::SelectionData::get_targets | ( | ) | const |
See also Gdk::Clipboard::get_formats()
Glib::ustring Gtk::SelectionData::get_text | ( | ) | const |
Gets the contents of the selection data as a UTF-8 string.
Glib::RefPtr<Gdk::Texture> Gtk::SelectionData::get_texture | ( | ) | const |
Gets the contents of the selection data as a Gdk::Pixbuf.
nullptr
. If the result is non-nullptr
it must be freed with Glib::object_unref().
|
static |
Get the GType for this class, for use with the underlying GObject type system.
std::vector<Glib::ustring> Gtk::SelectionData::get_uris | ( | ) | const |
Gets the contents of the selection data as a vector of URIs.
|
inline |
Provides access to the underlying C instance.
|
inline |
Provides access to the underlying C instance.
GtkSelectionData* Gtk::SelectionData::gobj_copy | ( | ) | const |
Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.
SelectionData& Gtk::SelectionData::operator= | ( | const SelectionData& | other | ) |
|
noexcept |
void Gtk::SelectionData::set | ( | int | format, |
const guint8 * | data, | ||
int | length | ||
) |
Assign a memory block of raw data.
Store new data into the Gtk::SelectionData object. Should only be called from a selection handler callback. A 0-byte terminates the stored data. The type of data is determined by get_target().
format | The data format, i.e. the number of bits in a unit. |
data | Pointer to the data (will be copied). |
length | The length of the data block in bytes. |
void Gtk::SelectionData::set | ( | const std::string & | type, |
int | format, | ||
const guint8 * | data, | ||
int | length | ||
) |
Assign a memory block of raw data.
Store new data into the Gtk::SelectionData object. Should only be called from a selection handler callback. A 0-byte terminates the stored data.
type | The type of the selection data. |
format | The data format, i.e. the number of bits in a unit. |
data | Pointer to the data (will be copied). |
length | The length of the data block in bytes. |
void Gtk::SelectionData::set | ( | const std::string & | type, |
const std::string & | data | ||
) |
Assign a string of raw data.
Store new data into the Gtk::SelectionData object. Should only be called from a selection handler callback.
type | The type of the selection data. |
data | A string that contains the data (does not have to be text). |
bool Gtk::SelectionData::set_pixbuf | ( | const Glib::RefPtr< const Gdk::Pixbuf >& | pixbuf | ) |
Sets the contents of the selection from a Gdk::Pixbuf The pixbuf is converted to the form determined by selection_data->target.
pixbuf | A Gdk::Pixbuf. |
true
if the selection was successfully set, otherwise false
. bool Gtk::SelectionData::set_text | ( | const Glib::ustring & | data | ) |
Assign UTF-8 encoded text.
Sets the contents of the selection from a UTF-8 encoded string. The string is converted to the form determined by get_target().
data | A UTF-8 encoded string. |
true
if the selection was successfully set, otherwise false
. bool Gtk::SelectionData::set_texture | ( | const Glib::RefPtr< const Gdk::Texture >& | texture | ) |
Sets the contents of the selection from a Gdk::Texture.
The surface is converted to the form determined by selection_data->target.
texture | A Gdk::Texture. |
true
if the selection was successfully set, otherwise false
. bool Gtk::SelectionData::set_uris | ( | const std::vector< Glib::ustring > & | uris | ) |
Sets the contents of the selection from a list of URIs.
The string is converted to the form determined by selection_data->target.
uris | A nullptr -terminated array of strings holding URIs. |
true
if the selection was successfully set, otherwise false
.
|
noexcept |
bool Gtk::SelectionData::targets_include_image | ( | bool | writable = true | ) | const |
Given a Gtk::SelectionData object holding a list of targets, determines if any of the targets in targets can be used to provide a Gdk::Pixbuf.
writable | Whether to accept only targets for which GTK+ knows how to convert a pixbuf into the format. |
true
if selection_data holds a list of targets, and a suitable target for images is included, otherwise false
. bool Gtk::SelectionData::targets_include_text | ( | ) | const |
Given a Gtk::SelectionData object holding a list of targets, determines if any of the targets in targets can be used to provide text.
true
if selection_data holds a list of targets, and a suitable target for text is included, otherwise false
. bool Gtk::SelectionData::targets_include_uri | ( | ) | const |
Given a Gtk::SelectionData object holding a list of targets, determines if any of the targets in targets can be used to provide a list or URIs.
true
if selection_data holds a list of targets, and a suitable target for URI lists is included, otherwise false
.
|
related |
lhs | The left-hand side |
rhs | The right-hand side |
|
related |
A Glib::wrap() method for this object.
object | The C instance. |
take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |
|
protected |