Struct gdk4::ContentFormats

pub struct ContentFormats { /* private fields */ }

The ContentFormats structure is used to advertise and negotiate the format of content.

You will encounter ContentFormats when interacting with objects controlling operations that pass data between different widgets, window or application, like Drag, Drop, Clipboard or ContentProvider.

GDK supports content in 2 forms: GType and mime type. Using GTypes is meant only for in-process content transfers. Mime types are meant to be used for data passing both in-process and out-of-process. The details of how data is passed is described in the documentation of the actual implementations. To transform between the two forms, ContentSerializer and ContentDeserializer are used.

A ContentFormats describes a set of possible formats content can be exchanged in. It is assumed that this set is ordered. GTypes are more important than mime types. Order between different GTypes or mime types is the order they were added in, most important first. Functions that care about order, such as union(), will describe in their documentation how they interpret that order, though in general the order of the first argument is considered the primary order of the result, followed by the order of further arguments.

For debugging purposes, the function to_str() exists. It will print a comma-separated list of formats from most important to least important.

ContentFormats is an immutable struct. After creation, you cannot change the types it represents. Instead, new ContentFormats have to be created. The ContentFormatsBuilder structure is meant to help in this endeavor.

Implementations

impl ContentFormats

pub fn as_ptr(&self) -> *mut GdkContentFormats

Return the inner pointer to the underlying C value.

pub unsafe fn from_glib_ptr_borrow<'a>( ptr: *const *const GdkContentFormats ) -> &'a Self

Borrows the underlying C value.

impl ContentFormats

pub fn new(mime_types: &[&str]) -> ContentFormats

Creates a new ContentFormats from an array of mime types.

The mime types must be valid and different from each other or the behavior of the return value is undefined. If you cannot guarantee this, use ContentFormatsBuilder instead.

mime_types

Pointer to an array of mime types

Returns

the new ContentFormats.

pub fn for_type(type_: Type) -> ContentFormats

Creates a new ContentFormats for a given GType.

type_

a GType

Returns

a new ContentFormats

pub fn contains_type(&self, type_: Type) -> bool

Checks if a given GType is part of the given @self.

type_

the GType to search for

Returns

true if the GType was found

pub fn contain_mime_type(&self, mime_type: &str) -> bool

Checks if a given mime type is part of the given @self.

mime_type

the mime type to search for

Returns

true if the mime_type was found

pub fn mime_types(&self) -> Vec<GString>

Gets the mime types included in @self.

Note that @self may not contain any mime types, in particular when they are empty. In that case None will be returned.

Returns

None-terminated array of interned strings of mime types included in @self

pub fn match_(&self, second: &ContentFormats) -> bool

pub fn match_type(&self, second: &ContentFormats) -> Type

Finds the first GType from @self that is also contained in @second.

If no matching GType is found, G_TYPE_INVALID is returned.

second

the ContentFormats to intersect with

Returns

The first common GType or G_TYPE_INVALID if none.

pub fn match_mime_type(&self, second: &ContentFormats) -> Option<GString>

Finds the first mime type from @self that is also contained in @second.

If no matching mime type is found, None is returned.

second

the ContentFormats to intersect with

Returns

The first common mime type or None if none

pub fn to_str(&self) -> GString

Prints the given @self into a human-readable string.

The resulting string can be parsed with parse().

This is a small wrapper around Gdk::ContentFormats::print() to help when debugging.

Returns

a new string

pub fn union(self, second: &ContentFormats) -> ContentFormats

Append all missing types from @second to @self, in the order they had in @second.

second

the ContentFormats to merge from

Returns

a new ContentFormats

pub fn union_deserialize_types(self) -> ContentFormats

Add GTypes for mime types in @self for which deserializers are registered.

Returns

a new ContentFormats

pub fn union_deserialize_mime_types(self) -> ContentFormats

Add mime types for GTypes in @self for which deserializers are registered.

Returns

a new ContentFormats

pub fn union_serialize_types(self) -> ContentFormats

Add GTypes for the mime types in @self for which serializers are registered.

Returns

a new ContentFormats

pub fn union_serialize_mime_types(self) -> ContentFormats

Add mime types for GTypes in @self for which serializers are registered.

Returns

a new ContentFormats

pub fn parse(string: &str) -> Result<ContentFormats, BoolError>

Available on crate feature v4_4 only.

Parses the given @string into ContentFormats and returns the formats.

Strings printed via to_str() can be read in again successfully using this function.

If @string does not describe valid content formats, None is returned.

string

the string to parse

Returns

the content formats if @string is valid

impl ContentFormats

pub fn types(&self) -> Slice<Type>

Gets the GTypes included in @self.

Note that @self may not contain any GTypes, in particular when they are empty. In that case None will be returned.

Returns

G_TYPE_INVALID-terminated array of types included in @self

pub fn builder() -> ContentFormatsBuilder

Creates a new builder-pattern struct instance to construct ContentFormats objects.

This method returns an instance of ContentFormatsBuilder which can be used to create ContentFormats objects.

Trait Implementations

impl Clone for ContentFormats

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ContentFormats

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for ContentFormats

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<ContentFormats> for Value

fn from(s: ContentFormats) -> Self

Converts to this type from the input type.

impl FromStr for ContentFormats

Available on crate feature v4_4 only.

type Err = BoolError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl HasParamSpec for ContentFormats

type ParamSpec = ParamSpecBoxed

type SetValue = ContentFormats

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecBoxedBuilder<'_, ContentFormats>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ContentFormats

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ContentFormats

fn cmp(&self, other: &ContentFormats) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ContentFormats

fn eq(&self, other: &ContentFormats) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ContentFormats

fn partial_cmp(&self, other: &ContentFormats) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for ContentFormats

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ContentFormats

impl StructuralPartialEq for ContentFormats