Struct sourceview4::Completion

pub struct Completion { /* private fields */ }

Expand description

Properties

`accelerators`

Number of keyboard accelerators to show for the first proposals. For example, to activate the first proposal, the user can press <keycombo>``<keycap>Alt</keycap>``<keycap>1</keycap>``</keycombo>.

Readable | Writeable | Construct

`auto-complete-delay`

Determines the popup delay (in milliseconds) at which the completion will be shown for interactive completion.

Readable | Writeable | Construct

`proposal-page-size`

The scroll page size of the proposals in the completion window. In other words, when <keycap>PageDown</keycap> or <keycap>PageUp</keycap> is pressed, the selected proposal becomes the one which is located one page size backward or forward.

See also the move-cursor signal.

Readable | Writeable | Construct

`provider-page-size`

The scroll page size of the provider pages in the completion window.

See the move-page signal.

Readable | Writeable | Construct

`remember-info-visibility`

Determines whether the visibility of the info window should be saved when the completion is hidden, and restored when the completion is shown again.

Readable | Writeable | Construct

`select-on-show`

Determines whether the first proposal should be selected when the completion is first shown.

Readable | Writeable | Construct

`show-headers`

Determines whether provider headers should be shown in the proposal list. It can be useful to disable when there is only one provider.

Readable | Writeable | Construct

`show-icons`

Determines whether provider and proposal icons should be shown in the completion popup.

Readable | Writeable | Construct

`view`

The View bound to the completion object.

Readable | Writeable | Construct Only

Signals

`activate-proposal`

The activate-proposal signal is a keybinding signal which gets emitted when the user initiates a proposal activation.

Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to control the proposal activation programmatically.

Action

`hide`

Emitted when the completion window is hidden. The default handler will actually hide the window.

Action

`move-cursor`

The move-cursor signal is a keybinding signal which gets emitted when the user initiates a cursor movement.

The <keycap>Up</keycap>, <keycap>Down</keycap>, <keycap>PageUp</keycap>, <keycap>PageDown</keycap>, <keycap>Home</keycap> and <keycap>End</keycap> keys are bound to the normal behavior expected by those keys.

When step is equal to gtk::ScrollStep::Pages, the page size is defined by the proposal-page-size property. It is used for the <keycap>PageDown</keycap> and <keycap>PageUp</keycap> keys.

Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to control the cursor programmatically.

Action

`move-page`

The move-page signal is a keybinding signal which gets emitted when the user initiates a page movement (i.e. switches between provider pages).

<keycombo>``<keycap>Control</keycap>``<keycap>Left</keycap>``</keycombo> is for going to the previous provider. <keycombo>``<keycap>Control</keycap>``<keycap>Right</keycap>``</keycombo> is for going to the next provider. <keycombo>``<keycap>Control</keycap>``<keycap>Home</keycap>``</keycombo> is for displaying all the providers. <keycombo>``<keycap>Control</keycap>``<keycap>End</keycap>``</keycombo> is for going to the last provider.

When step is equal to gtk::ScrollStep::Pages, the page size is defined by the provider-page-size property.

Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to control the page selection programmatically.

Action

`populate-context`

Emitted just before starting to populate the completion with providers. You can use this signal to add additional attributes in the context.

Action

`show`

Emitted when the completion window is shown. The default handler will actually show the window.

Action

Implements

CompletionExt, gtk::prelude::BuildableExt

Implementations§

impl Completion

pub const NONE: Option<&'static Completion> = None

pub fn builder() -> CompletionBuilder

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

This method returns an instance of CompletionBuilder which can be used to create Completion objects.

Trait Implementations§

impl Clone for Completion

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for Completion

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

Formats the value using the given formatter. Read more

impl Display for Completion

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

Formats the value using the given formatter. Read more

impl HasParamSpec for Completion

type ParamSpec = ParamSpecObject

type SetValue = Completion

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

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Completion>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Completion

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

Feeds this value into the given Hasher. Read more

1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more

impl Ord for Completion

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

This method returns an Ordering between self and other. Read more

1.21.0 · source§

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

Compares and returns the maximum of two values. Read more

1.21.0 · source§

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

Compares and returns the minimum of two values. Read more

1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more

impl ParentClassIs for Completion

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for Completion

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

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

1.0.0 · source§

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<OT: ObjectType> PartialOrd<OT> for Completion

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

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

1.0.0 · source§

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

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

1.0.0 · source§

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

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

1.0.0 · source§

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

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

1.0.0 · source§

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

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

impl StaticType for Completion

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Completion

impl IsA<Buildable> for Completion

Auto Trait Implementations§

impl RefUnwindSafe for Completion

impl !Send for Completion

impl !Sync for Completion

impl Unpin for Completion

impl UnwindSafe for Completion

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<O> BuildableExt for O
where O: IsA<Buildable>,

fn add_child( &self, builder: &impl IsA<Builder>, child: &impl IsA<Object>, type_: Option<&str> )

fn construct_child( &self, builder: &impl IsA<Builder>, name: &str ) -> Option<Object>

fn internal_child( &self, builder: &impl IsA<Builder>, childname: &str ) -> Option<Object>

fn parser_finished(&self, builder: &impl IsA<Builder>)

fn set_buildable_property( &self, builder: &impl IsA<Builder>, name: &str, value: &Value )

impl<O> BuildableExtManual for O
where O: IsA<Buildable>,

fn buildable_name(&self) -> Option<String>

fn set_buildable_name(&self, name: &str)

impl<T> Cast for T
where T: ObjectType,

fn upcast<T>(self) -> T
where T: ObjectType, Self: IsA<T>,

Upcasts an object to a superclass or interface T. Read more

fn upcast_ref<T>(&self) -> &T
where T: ObjectType, Self: IsA<T>,

Upcasts an object to a reference of its superclass or interface T. Read more

fn downcast<T>(self) -> Result<T, Self>
where T: ObjectType, Self: MayDowncastTo<T>,

Tries to downcast to a subclass or interface implementor T. Read more

fn downcast_ref<T>(&self) -> Option<&T>
where T: ObjectType, Self: MayDowncastTo<T>,

Tries to downcast to a reference of its subclass or interface implementor T. Read more

fn dynamic_cast<T>(self) -> Result<T, Self>
where T: ObjectType,

Tries to cast to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while upcast will do many checks at compile-time already. downcast will perform the same checks at runtime as dynamic_cast, but will also ensure some amount of compile-time safety. Read more

fn dynamic_cast_ref<T>(&self) -> Option<&T>
where T: ObjectType,

Tries to cast to reference to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

unsafe fn unsafe_cast<T>(self) -> T
where T: ObjectType,

Casts to T unconditionally. Read more

unsafe fn unsafe_cast_ref<T>(&self) -> &T
where T: ObjectType,

Casts to &T unconditionally. Read more

impl<O> CompletionExt for O
where O: IsA<Completion>,

fn add_provider( &self, provider: &impl IsA<CompletionProvider> ) -> Result<(), Error>

Add a new CompletionProvider to the completion object. This will add a reference provider, so make sure to unref your own copy when you no longer need it. Read more

fn block_interactive(&self)

Block interactive completion. This can be used to disable interactive completion when inserting or deleting text from the buffer associated with the completion. Use unblock_interactive() to enable interactive completion again. Read more

fn info_window(&self) -> Option<CompletionInfo>

The info widget is the window where the completion displays optional extra information of the proposal. Read more

fn providers(&self) -> Vec<CompletionProvider>

Get list of providers registered on self. The returned list is owned by the completion and should not be freed. Read more

fn view(&self) -> Option<View>

The View associated with self, or None if the view has been destroyed. Read more

fn hide(&self)

Hides the completion if it is active (visible).

fn remove_provider( &self, provider: &impl IsA<CompletionProvider> ) -> Result<(), Error>

Remove provider from the completion. Read more

fn start( &self, providers: &[CompletionProvider], context: &impl IsA<CompletionContext> ) -> bool

Starts a new completion with the specified CompletionContext and a list of potential candidate providers for completion. Read more

fn unblock_interactive(&self)

Unblock interactive completion. This can be used after using block_interactive() to enable interactive completion again.

fn accelerators(&self) -> u32

Number of keyboard accelerators to show for the first proposals. For example, to activate the first proposal, the user can press <keycombo>``<keycap>Alt</keycap>``<keycap>1</keycap>``</keycombo>.

fn set_accelerators(&self, accelerators: u32)

Number of keyboard accelerators to show for the first proposals. For example, to activate the first proposal, the user can press <keycombo>``<keycap>Alt</keycap>``<keycap>1</keycap>``</keycombo>.

fn auto_complete_delay(&self) -> u32

Determines the popup delay (in milliseconds) at which the completion will be shown for interactive completion.

fn set_auto_complete_delay(&self, auto_complete_delay: u32)

Determines the popup delay (in milliseconds) at which the completion will be shown for interactive completion.

fn proposal_page_size(&self) -> u32

The scroll page size of the proposals in the completion window. In other words, when <keycap>PageDown</keycap> or <keycap>PageUp</keycap> is pressed, the selected proposal becomes the one which is located one page size backward or forward. Read more

fn set_proposal_page_size(&self, proposal_page_size: u32)

The scroll page size of the proposals in the completion window. In other words, when <keycap>PageDown</keycap> or <keycap>PageUp</keycap> is pressed, the selected proposal becomes the one which is located one page size backward or forward. Read more

fn provider_page_size(&self) -> u32

The scroll page size of the provider pages in the completion window. Read more

fn set_provider_page_size(&self, provider_page_size: u32)

The scroll page size of the provider pages in the completion window. Read more

fn is_remember_info_visibility(&self) -> bool

Determines whether the visibility of the info window should be saved when the completion is hidden, and restored when the completion is shown again.

fn set_remember_info_visibility(&self, remember_info_visibility: bool)

Determines whether the visibility of the info window should be saved when the completion is hidden, and restored when the completion is shown again.

fn selects_on_show(&self) -> bool

Determines whether the first proposal should be selected when the completion is first shown.

fn set_select_on_show(&self, select_on_show: bool)

Determines whether the first proposal should be selected when the completion is first shown.

fn shows_headers(&self) -> bool

Determines whether provider headers should be shown in the proposal list. It can be useful to disable when there is only one provider.

fn set_show_headers(&self, show_headers: bool)

Determines whether provider headers should be shown in the proposal list. It can be useful to disable when there is only one provider.

fn shows_icons(&self) -> bool

Determines whether provider and proposal icons should be shown in the completion popup.

fn set_show_icons(&self, show_icons: bool)

Determines whether provider and proposal icons should be shown in the completion popup.

fn connect_activate_proposal<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

The activate-proposal signal is a keybinding signal which gets emitted when the user initiates a proposal activation. Read more

fn emit_activate_proposal(&self)

fn connect_hide<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

Emitted when the completion window is hidden. The default handler will actually hide the window.

fn emit_hide(&self)

fn connect_move_cursor<F: Fn(&Self, ScrollStep, i32) + 'static>( &self, f: F ) -> SignalHandlerId

The move-cursor signal is a keybinding signal which gets emitted when the user initiates a cursor movement. Read more

fn emit_move_cursor(&self, step: ScrollStep, num: i32)

fn connect_move_page<F: Fn(&Self, ScrollStep, i32) + 'static>( &self, f: F ) -> SignalHandlerId

The move-page signal is a keybinding signal which gets emitted when the user initiates a page movement (i.e. switches between provider pages). Read more

fn emit_move_page(&self, step: ScrollStep, num: i32)

fn connect_populate_context<F: Fn(&Self, &CompletionContext) + 'static>( &self, f: F ) -> SignalHandlerId

Emitted just before starting to populate the completion with providers. You can use this signal to add additional attributes in the context. Read more

fn emit_populate_context(&self, context: &CompletionContext)

fn connect_show<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

Emitted when the completion window is shown. The default handler will actually show the window.

fn emit_show(&self)

fn connect_accelerators_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

fn connect_auto_complete_delay_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

fn connect_proposal_page_size_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

fn connect_provider_page_size_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

fn connect_remember_info_visibility_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

fn connect_select_on_show_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

fn connect_show_headers_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

fn connect_show_icons_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

unsafe fn from_glib_none_num_as_vec(ptr: *const GList, num: usize) -> Vec<T>

unsafe fn from_glib_container_num_as_vec(_: *const GList, _: usize) -> Vec<T>

unsafe fn from_glib_full_num_as_vec(_: *const GList, _: usize) -> Vec<T>

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

unsafe fn from_glib_none_num_as_vec(ptr: *const GPtrArray, num: usize) -> Vec<T>

unsafe fn from_glib_container_num_as_vec( _: *const GPtrArray, _: usize ) -> Vec<T>

unsafe fn from_glib_full_num_as_vec(_: *const GPtrArray, _: usize) -> Vec<T>

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

unsafe fn from_glib_none_num_as_vec(ptr: *const GSList, num: usize) -> Vec<T>

unsafe fn from_glib_container_num_as_vec(_: *const GSList, _: usize) -> Vec<T>

unsafe fn from_glib_full_num_as_vec(_: *const GSList, _: usize) -> Vec<T>

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

unsafe fn from_glib_none_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

unsafe fn from_glib_container_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

unsafe fn from_glib_full_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

unsafe fn from_glib_none_num_as_vec(ptr: *mut GPtrArray, num: usize) -> Vec<T>

unsafe fn from_glib_container_num_as_vec( ptr: *mut GPtrArray, num: usize ) -> Vec<T>

unsafe fn from_glib_full_num_as_vec(ptr: *mut GPtrArray, num: usize) -> Vec<T>

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

unsafe fn from_glib_none_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

unsafe fn from_glib_container_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

unsafe fn from_glib_full_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

unsafe fn from_glib_none_as_vec(ptr: *const GList) -> Vec<T>

unsafe fn from_glib_container_as_vec(_: *const GList) -> Vec<T>

unsafe fn from_glib_full_as_vec(_: *const GList) -> Vec<T>

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

unsafe fn from_glib_none_as_vec(ptr: *const GPtrArray) -> Vec<T>

unsafe fn from_glib_container_as_vec(_: *const GPtrArray) -> Vec<T>

unsafe fn from_glib_full_as_vec(_: *const GPtrArray) -> Vec<T>

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

unsafe fn from_glib_none_as_vec(ptr: *const GSList) -> Vec<T>

unsafe fn from_glib_container_as_vec(_: *const GSList) -> Vec<T>

unsafe fn from_glib_full_as_vec(_: *const GSList) -> Vec<T>

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

unsafe fn from_glib_none_as_vec(ptr: *mut GList) -> Vec<T>

unsafe fn from_glib_container_as_vec(ptr: *mut GList) -> Vec<T>

unsafe fn from_glib_full_as_vec(ptr: *mut GList) -> Vec<T>

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

unsafe fn from_glib_none_as_vec(ptr: *mut GPtrArray) -> Vec<T>

unsafe fn from_glib_container_as_vec(ptr: *mut GPtrArray) -> Vec<T>

unsafe fn from_glib_full_as_vec(ptr: *mut GPtrArray) -> Vec<T>

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

unsafe fn from_glib_none_as_vec(ptr: *mut GSList) -> Vec<T>

unsafe fn from_glib_container_as_vec(ptr: *mut GSList) -> Vec<T>

unsafe fn from_glib_full_as_vec(ptr: *mut GSList) -> Vec<T>

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoClosureReturnValue for T
where T: Into<Value>,

fn into_closure_return_value(self) -> Option<Value>

impl<U> IsSubclassableExt for U
where U: IsClass + ParentClassIs,

fn parent_class_init<T>(class: &mut Class<U>)
where T: ObjectSubclass, <U as ParentClassIs>::Parent: IsSubclassable<T>,

fn parent_instance_init<T>(instance: &mut InitializingObject<T>)
where T: ObjectSubclass, <U as ParentClassIs>::Parent: IsSubclassable<T>,

impl<T> ObjectExt for T
where T: ObjectType,

fn is<U>(&self) -> bool
where U: StaticType,

Returns true if the object is an instance of (can be cast to) T.

fn type_(&self) -> Type

Returns the type of the object.

fn object_class(&self) -> &Class<Object>

Returns the ObjectClass of the object. Read more

fn class(&self) -> &Class<T>
where T: IsClass,

Returns the class of the object.

fn class_of<U>(&self) -> Option<&Class<U>>
where U: IsClass,

Returns the class of the object in the given type T. Read more

fn interface<U>(&self) -> Option<InterfaceRef<'_, U>>
where U: IsInterface,

Returns the interface T of the object. Read more

fn set_property(&self, property_name: &str, value: impl Into<Value>)

Sets the property property_name of the object to value value. Read more

fn set_property_from_value(&self, property_name: &str, value: &Value)

Sets the property property_name of the object to value value. Read more

fn set_properties(&self, property_values: &[(&str, &dyn ToValue)])

Sets multiple properties of the object at once. Read more

fn set_properties_from_value(&self, property_values: &[(&str, Value)])

Sets multiple properties of the object at once. Read more

fn property<V>(&self, property_name: &str) -> V
where V: for<'b> FromValue<'b> + 'static,

Gets the property property_name of the object and cast it to the type V. Read more

fn property_value(&self, property_name: &str) -> Value

Gets the property property_name of the object. Read more

fn has_property(&self, property_name: &str, type_: Option<Type>) -> bool

Check if the object has a property property_name of the given type_. Read more

fn property_type(&self, property_name: &str) -> Option<Type>

Get the type of the property property_name of this object. Read more

fn find_property(&self, property_name: &str) -> Option<ParamSpec>

Get the ParamSpec of the property property_name of this object.

fn list_properties(&self) -> PtrSlice<ParamSpec>

Return all ParamSpec of the properties of this object.

fn freeze_notify(&self) -> PropertyNotificationFreezeGuard

Freeze all property notifications until the return guard object is dropped. Read more

unsafe fn set_qdata<QD>(&self, key: Quark, value: QD)
where QD: 'static,

Set arbitrary data on this object with the given key. Read more

unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>>
where QD: 'static,

Return previously set arbitrary data of this object with the given key. Read more

unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD>
where QD: 'static,

Retrieve previously set arbitrary data of this object with the given key. Read more

unsafe fn set_data<QD>(&self, key: &str, value: QD)
where QD: 'static,

Set arbitrary data on this object with the given key. Read more

unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>>
where QD: 'static,

Return previously set arbitrary data of this object with the given key. Read more

unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD>
where QD: 'static,

Retrieve previously set arbitrary data of this object with the given key. Read more

fn block_signal(&self, handler_id: &SignalHandlerId)

Block a given signal handler. Read more

fn unblock_signal(&self, handler_id: &SignalHandlerId)

Unblock a given signal handler.

fn stop_signal_emission(&self, signal_id: SignalId, detail: Option<Quark>)

Stop emission of the currently emitted signal.

fn stop_signal_emission_by_name(&self, signal_name: &str)

Stop emission of the currently emitted signal by the (possibly detailed) signal name.

fn connect<F>( &self, signal_name: &str, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,

Connect to the signal signal_name on this object. Read more

fn connect_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,

Connect to the signal signal_id on this object. Read more

fn connect_local<F>( &self, signal_name: &str, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + 'static,

Connect to the signal signal_name on this object. Read more

fn connect_local_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + 'static,

Connect to the signal signal_id on this object. Read more

unsafe fn connect_unsafe<F>( &self, signal_name: &str, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value>,

Connect to the signal signal_name on this object. Read more

unsafe fn connect_unsafe_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value>,

Connect to the signal signal_id on this object. Read more

fn connect_closure( &self, signal_name: &str, after: bool, closure: RustClosure ) -> SignalHandlerId

Connect a closure to the signal signal_name on this object. Read more

fn connect_closure_id( &self, signal_id: SignalId, details: Option<Quark>, after: bool, closure: RustClosure ) -> SignalHandlerId

Connect a closure to the signal signal_id on this object. Read more

fn watch_closure(&self, closure: &impl AsRef<Closure>)

Limits the lifetime of closure to the lifetime of the object. When the object’s reference count drops to zero, the closure will be invalidated. An invalidated closure will ignore any calls to invoke_with_values, or invoke when using Rust closures.

fn emit<R>(&self, signal_id: SignalId, args: &[&dyn ToValue]) -> R
where R: TryFromClosureReturnValue,

Emit signal by signal id. Read more

fn emit_with_values(&self, signal_id: SignalId, args: &[Value]) -> Option<Value>

Same as Self::emit but takes Value for the arguments.

fn emit_by_name<R>(&self, signal_name: &str, args: &[&dyn ToValue]) -> R
where R: TryFromClosureReturnValue,

Emit signal by its name. Read more

fn emit_by_name_with_values( &self, signal_name: &str, args: &[Value] ) -> Option<Value>

Emit signal by its name. Read more

fn emit_by_name_with_details<R>( &self, signal_name: &str, details: Quark, args: &[&dyn ToValue] ) -> R
where R: TryFromClosureReturnValue,

Emit signal by its name with details. Read more

fn emit_by_name_with_details_and_values( &self, signal_name: &str, details: Quark, args: &[Value] ) -> Option<Value>

Emit signal by its name with details. Read more

fn emit_with_details<R>( &self, signal_id: SignalId, details: Quark, args: &[&dyn ToValue] ) -> R
where R: TryFromClosureReturnValue,

Emit signal by signal id with details. Read more

fn emit_with_details_and_values( &self, signal_id: SignalId, details: Quark, args: &[Value] ) -> Option<Value>

Emit signal by signal id with details. Read more

fn disconnect(&self, handler_id: SignalHandlerId)

Disconnect a previously connected signal handler.

fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
where F: Fn(&T, &ParamSpec) + Send + Sync + 'static,

Connect to the notify signal of the object. Read more

fn connect_notify_local<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
where F: Fn(&T, &ParamSpec) + 'static,

Connect to the notify signal of the object. Read more

unsafe fn connect_notify_unsafe<F>( &self, name: Option<&str>, f: F ) -> SignalHandlerId
where F: Fn(&T, &ParamSpec),

Connect to the notify signal of the object. Read more

fn notify(&self, property_name: &str)

Notify that the given property has changed its value. Read more

fn notify_by_pspec(&self, pspec: &ParamSpec)

Notify that the given property has changed its value. Read more

fn downgrade(&self) -> WeakRef<T>

Downgrade this object to a weak reference.

fn add_weak_ref_notify<F>(&self, f: F) -> WeakRefNotify<T>
where F: FnOnce() + Send + 'static,

Add a callback to be notified when the Object is disposed.

fn add_weak_ref_notify_local<F>(&self, f: F) -> WeakRefNotify<T>
where F: FnOnce() + 'static,

Add a callback to be notified when the Object is disposed. Read more

fn bind_property<'f, 't, O, 'a>( &'a self, source_property: &'a str, target: &'a O, target_property: &'a str ) -> BindingBuilder<'a, 'f, 't>
where O: ObjectType,

Bind property source_property on this object to the target_property on the target object. Read more

fn ref_count(&self) -> u32

Returns the strong reference count of this object.

unsafe fn run_dispose(&self)

Runs the dispose mechanism of the object. Read more

impl<T> Property for T
where T: HasParamSpec,

type Value = T

impl<T> PropertyGet for T
where T: HasParamSpec,

type Value = T

fn get<R, F>(&self, f: F) -> R
where F: Fn(&<T as PropertyGet>::Value) -> R,

impl<T> StaticTypeExt for T
where T: StaticType,

fn ensure_type()

Ensures that the type has been registered with the type system.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T> TransparentType for T
where T: TransparentPtrType,

type GlibType = <T as GlibPtrDefault>::GlibType

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T> TryFromClosureReturnValue for T
where T: for<'a> FromValue<'a> + StaticType + 'static,

fn try_from_closure_return_value(v: Option<Value>) -> Result<T, BoolError>

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<'a, T, C, E> FromValueOptional<'a> for T
where T: FromValue<'a, Checker = C>, C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError<E>>, E: Error + Send + 'static,

impl<Super, Sub> MayDowncastTo<Sub> for Super
where Super: IsA<Super>, Sub: IsA<Super>,