Struct sourceview5::SearchContext [−][src]
Implementations
impl SearchContext[src]
pub fn new<P: IsA<Buffer>, Q: IsA<SearchSettings>>(
buffer: &P,
settings: Option<&Q>
) -> SearchContext[src]
buffer: &P,
settings: Option<&Q>
) -> SearchContext
Creates a new search context, associated with buffer, and customized with
settings. If settings is None, a new SearchSettings object will
be created, that you can retrieve with
SearchContext::get_settings.
buffer
a Buffer.
settings
a SearchSettings, or None.
Returns
a new search context.
pub fn backward(&self, iter: &TextIter) -> Option<(TextIter, TextIter, bool)>[src]
Synchronous backward search. It is recommended to use the asynchronous
functions instead, to not block the user interface. However, if you are sure
that the buffer is small, this function is more convenient to use.
If the SearchSettings:wrap-around property is false, this function
doesn’t try to wrap around.
The has_wrapped_around out parameter is set independently of whether a match
is found. So if this function returns false, has_wrapped_around will have
the same value as the SearchSettings:wrap-around property.
iter
start of search.
match_start
return location for start of match, or None.
match_end
return location for end of match, or None.
has_wrapped_around
return location to know whether the
search has wrapped around, or None.
Returns
whether a match was found.
pub fn backward_async<P: IsA<Cancellable>, Q: FnOnce(Result<(TextIter, TextIter, bool), Error>) + Send + 'static>(
&self,
iter: &TextIter,
cancellable: Option<&P>,
callback: Q
)[src]
&self,
iter: &TextIter,
cancellable: Option<&P>,
callback: Q
)
The asynchronous version of SearchContext::backward.
See the documentation of SearchContext::backward for more
details.
See the gio::AsyncResult documentation to know how to use this function.
If the operation is cancelled, the callback will only be called if
cancellable was not None. SearchContext::backward_async takes
ownership of cancellable, so you can unref it after calling this function.
iter
start of search.
cancellable
a gio::Cancellable, or None.
callback
a GAsyncReadyCallback to call when the operation is finished.
user_data
the data to pass to the callback function.
pub fn backward_async_future(
&self,
iter: &TextIter
) -> Pin<Box_<dyn Future<Output = Result<(TextIter, TextIter, bool), Error>> + 'static>>[src]
&self,
iter: &TextIter
) -> Pin<Box_<dyn Future<Output = Result<(TextIter, TextIter, bool), Error>> + 'static>>
pub fn forward(&self, iter: &TextIter) -> Option<(TextIter, TextIter, bool)>[src]
Synchronous forward search. It is recommended to use the asynchronous
functions instead, to not block the user interface. However, if you are sure
that the buffer is small, this function is more convenient to use.
If the SearchSettings:wrap-around property is false, this function
doesn’t try to wrap around.
The has_wrapped_around out parameter is set independently of whether a match
is found. So if this function returns false, has_wrapped_around will have
the same value as the SearchSettings:wrap-around property.
iter
start of search.
match_start
return location for start of match, or None.
match_end
return location for end of match, or None.
has_wrapped_around
return location to know whether the
search has wrapped around, or None.
Returns
whether a match was found.
pub fn forward_async<P: IsA<Cancellable>, Q: FnOnce(Result<(TextIter, TextIter, bool), Error>) + Send + 'static>(
&self,
iter: &TextIter,
cancellable: Option<&P>,
callback: Q
)[src]
&self,
iter: &TextIter,
cancellable: Option<&P>,
callback: Q
)
The asynchronous version of SearchContext::forward.
See the documentation of SearchContext::forward for more
details.
See the gio::AsyncResult documentation to know how to use this function.
If the operation is cancelled, the callback will only be called if
cancellable was not None. SearchContext::forward_async takes
ownership of cancellable, so you can unref it after calling this function.
iter
start of search.
cancellable
a gio::Cancellable, or None.
callback
a GAsyncReadyCallback to call when the operation is finished.
user_data
the data to pass to the callback function.
pub fn forward_async_future(
&self,
iter: &TextIter
) -> Pin<Box_<dyn Future<Output = Result<(TextIter, TextIter, bool), Error>> + 'static>>[src]
&self,
iter: &TextIter
) -> Pin<Box_<dyn Future<Output = Result<(TextIter, TextIter, bool), Error>> + 'static>>
pub fn get_buffer(&self) -> Option<Buffer>[src]
Returns
the associated buffer.
pub fn get_highlight(&self) -> bool[src]
Returns
whether to highlight the search occurrences.
pub fn get_match_style(&self) -> Option<Style>[src]
Returns
the Style to apply on search matches.
pub fn get_occurrence_position(
&self,
match_start: &TextIter,
match_end: &TextIter
) -> i32[src]
&self,
match_start: &TextIter,
match_end: &TextIter
) -> i32
Gets the position of a search occurrence. If the buffer is not already fully
scanned, the position may be unknown, and -1 is returned. If 0 is returned,
it means that this part of the buffer has already been scanned, and that
match_start and match_end don’t delimit an occurrence.
match_start
the start of the occurrence.
match_end
the end of the occurrence.
Returns
the position of the search occurrence. The first occurrence has the
position 1 (not 0). Returns 0 if match_start and match_end don’t delimit
an occurrence. Returns -1 if the position is not yet known.
pub fn get_occurrences_count(&self) -> i32[src]
Gets the total number of search occurrences. If the buffer is not already fully scanned, the total number of occurrences is unknown, and -1 is returned.
Returns
the total number of search occurrences, or -1 if unknown.
pub fn get_regex_error(&self) -> Option<Error>[src]
Regular expression patterns must follow certain rules. If
SearchSettings:search-text breaks a rule, the error can be
retrieved with this function. The error domain is G_REGEX_ERROR.
Free the return value with glib::Error::free.
Returns
the glib::Error, or None if the
pattern is valid.
pub fn get_settings(&self) -> Option<SearchSettings>[src]
Returns
the search settings.
pub fn replace(
&self,
match_start: &mut TextIter,
match_end: &mut TextIter,
replace: &str
) -> Result<(), Error>[src]
&self,
match_start: &mut TextIter,
match_end: &mut TextIter,
replace: &str
) -> Result<(), Error>
Replaces a search match by another text. If match_start and match_end
doesn’t correspond to a search match, false is returned.
match_start and match_end iters are revalidated to point to the replacement
text boundaries.
For a regular expression replacement, you can check if replace is valid by
calling glib::Regex::check_replacement. The replace text can contain
backreferences; read the glib::Regex::replace documentation for more details.
match_start
the start of the match to replace.
match_end
the end of the match to replace.
replace
the replacement text.
replace_length
the length of replace in bytes, or -1.
Returns
whether the match has been replaced.
pub fn replace_all(&self, replace: &str) -> Result<(), Error>[src]
Replaces all search matches by another text. It is a synchronous function, so it can block the user interface.
For a regular expression replacement, you can check if replace is valid by
calling glib::Regex::check_replacement. The replace text can contain
backreferences; read the glib::Regex::replace documentation for more details.
replace
the replacement text.
replace_length
the length of replace in bytes, or -1.
Returns
the number of replaced matches.
pub fn set_highlight(&self, highlight: bool)[src]
pub fn set_match_style(&self, match_style: Option<&Style>)[src]
Set the style to apply on search matches. If match_style is None, default
theme’s scheme ‘match-style’ will be used.
To enable or disable the search highlighting, use
SearchContext::set_highlight.
match_style
a Style, or None.
pub fn connect_property_highlight_notify<F: Fn(&SearchContext) + 'static>(
&self,
f: F
) -> SignalHandlerId[src]
&self,
f: F
) -> SignalHandlerId
pub fn connect_property_match_style_notify<F: Fn(&SearchContext) + 'static>(
&self,
f: F
) -> SignalHandlerId[src]
&self,
f: F
) -> SignalHandlerId
pub fn connect_property_occurrences_count_notify<F: Fn(&SearchContext) + 'static>(
&self,
f: F
) -> SignalHandlerId[src]
&self,
f: F
) -> SignalHandlerId
pub fn connect_property_regex_error_notify<F: Fn(&SearchContext) + 'static>(
&self,
f: F
) -> SignalHandlerId[src]
&self,
f: F
) -> SignalHandlerId
Trait Implementations
impl Clone for SearchContext[src]
fn clone(&self) -> SearchContext[src]
pub fn clone_from(&mut self, source: &Self)1.0.0[src]
impl Debug for SearchContext[src]
impl Display for SearchContext[src]
impl Eq for SearchContext[src]
impl Hash for SearchContext[src]
fn hash<__H: Hasher>(&self, state: &mut __H)[src]
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher, 1.3.0[src]
H: Hasher,
impl Ord for SearchContext[src]
fn cmp(&self, other: &SearchContext) -> Ordering[src]
#[must_use]pub fn max(self, other: Self) -> Self1.21.0[src]
#[must_use]pub fn min(self, other: Self) -> Self1.21.0[src]
#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self1.50.0[src]
impl ParentClassIs for SearchContext[src]
type Parent = Object
impl<T: ObjectType> PartialEq<T> for SearchContext[src]
impl<T: ObjectType> PartialOrd<T> for SearchContext[src]
fn partial_cmp(&self, other: &T) -> Option<Ordering>[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool1.0.0[src]
impl StaticType for SearchContext[src]
fn static_type() -> Type[src]
impl StructuralEq for SearchContext[src]
Auto Trait Implementations
impl RefUnwindSafe for SearchContext
impl !Send for SearchContext
impl !Sync for SearchContext
impl Unpin for SearchContext
impl UnwindSafe for SearchContext
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T[src]
impl<Super, Sub> CanDowncast<Sub> for Super where
Sub: IsA<Super>,
Super: IsA<Super>,
Sub: IsA<Super>,
Super: IsA<Super>,
impl<T> Cast for T where
T: ObjectType,
T: ObjectType,
pub fn upcast<T>(self) -> T where
Self: IsA<T>,
T: ObjectType,
Self: IsA<T>,
T: ObjectType,
pub fn upcast_ref<T>(&self) -> &T where
Self: IsA<T>,
T: ObjectType,
Self: IsA<T>,
T: ObjectType,
pub fn downcast<T>(self) -> Result<T, Self> where
Self: CanDowncast<T>,
T: ObjectType,
Self: CanDowncast<T>,
T: ObjectType,
pub fn downcast_ref<T>(&self) -> Option<&T> where
Self: CanDowncast<T>,
T: ObjectType,
Self: CanDowncast<T>,
T: ObjectType,
pub fn dynamic_cast<T>(self) -> Result<T, Self> where
T: ObjectType,
T: ObjectType,
pub fn dynamic_cast_ref<T>(&self) -> Option<&T> where
T: ObjectType,
T: ObjectType,
pub unsafe fn unsafe_cast<T>(self) -> T where
T: ObjectType,
T: ObjectType,
pub unsafe fn unsafe_cast_ref<T>(&self) -> &T where
T: ObjectType,
T: ObjectType,
impl<T> From<T> for T[src]
impl<T, U> Into<U> for T where
U: From<T>, [src]
U: From<T>,
impl<T> ObjectExt for T where
T: ObjectType,
T: ObjectType,
pub fn is<U>(&self) -> bool where
U: StaticType,
U: StaticType,
pub fn get_type(&self) -> Type
pub fn get_object_class(&self) -> &Class<Object>
pub fn get_class(&self) -> &Class<T> where
T: IsClass,
T: IsClass,
pub fn get_class_of<U>(&self) -> Option<&Class<U>> where
U: IsClass,
U: IsClass,
pub fn get_interface<U>(&self) -> Option<InterfaceRef<'_, U>> where
U: IsInterface,
U: IsInterface,
pub fn set_properties(
&self,
property_values: &[(&str, &dyn ToValue)]
) -> Result<(), BoolError>
&self,
property_values: &[(&str, &dyn ToValue)]
) -> Result<(), BoolError>
pub fn set_properties_from_value(
&self,
property_values: &[(&str, Value)]
) -> Result<(), BoolError>
&self,
property_values: &[(&str, Value)]
) -> Result<(), BoolError>
pub fn set_property<'a, N, V>(
&self,
property_name: N,
value: &V
) -> Result<(), BoolError> where
V: ToValue,
N: Into<&'a str>,
&self,
property_name: N,
value: &V
) -> Result<(), BoolError> where
V: ToValue,
N: Into<&'a str>,
pub fn set_property_from_value<'a, N>(
&self,
property_name: N,
value: &Value
) -> Result<(), BoolError> where
N: Into<&'a str>,
&self,
property_name: N,
value: &Value
) -> Result<(), BoolError> where
N: Into<&'a str>,
pub fn get_property<'a, N>(&self, property_name: N) -> Result<Value, BoolError> where
N: Into<&'a str>,
N: Into<&'a str>,
pub unsafe fn set_qdata<QD>(&self, key: Quark, value: QD) where
QD: 'static,
QD: 'static,
pub unsafe fn get_qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>> where
QD: 'static,
QD: 'static,
pub unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD> where
QD: 'static,
QD: 'static,
pub unsafe fn set_data<QD>(&self, key: &str, value: QD) where
QD: 'static,
QD: 'static,
pub unsafe fn get_data<QD>(&self, key: &str) -> Option<NonNull<QD>> where
QD: 'static,
QD: 'static,
pub unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD> where
QD: 'static,
QD: 'static,
pub fn block_signal(&self, handler_id: &SignalHandlerId)
pub fn unblock_signal(&self, handler_id: &SignalHandlerId)
pub fn stop_signal_emission(&self, signal_name: &str)
pub fn disconnect(&self, handler_id: SignalHandlerId)
pub fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec) + Send + Sync,
F: 'static + Fn(&T, &ParamSpec) + Send + Sync,
pub fn connect_notify_local<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec),
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec),
pub unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: Fn(&T, &ParamSpec),
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: Fn(&T, &ParamSpec),
pub fn notify<'a, N>(&self, property_name: N) where
N: Into<&'a str>,
N: Into<&'a str>,
pub fn notify_by_pspec(&self, pspec: &ParamSpec)
pub fn has_property<'a, N>(&self, property_name: N, type_: Option<Type>) -> bool where
N: Into<&'a str>,
N: Into<&'a str>,
pub fn get_property_type<'a, N>(&self, property_name: N) -> Option<Type> where
N: Into<&'a str>,
N: Into<&'a str>,
pub fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where
N: Into<&'a str>,
N: Into<&'a str>,
pub fn list_properties(&self) -> Vec<ParamSpec, Global>
pub fn connect<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
N: Into<&'a str>,
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
N: Into<&'a str>,
pub fn connect_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
pub fn connect_local<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + 'static,
N: Into<&'a str>,
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + 'static,
N: Into<&'a str>,
pub fn connect_local_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + 'static,
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + 'static,
pub unsafe fn connect_unsafe<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value>,
N: Into<&'a str>,
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value>,
N: Into<&'a str>,
pub unsafe fn connect_unsafe_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value>,
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value>,
pub fn emit(
&self,
signal_id: SignalId,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>
&self,
signal_id: SignalId,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>
pub fn emit_with_details(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>
pub fn emit_by_name<'a, N>(
&self,
signal_name: N,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError> where
N: Into<&'a str>,
&self,
signal_name: N,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError> where
N: Into<&'a str>,
pub fn downgrade(&self) -> WeakRef<T>
pub fn bind_property<'a, O, N, M>(
&'a self,
source_property: N,
target: &'a O,
target_property: M
) -> BindingBuilder<'a> where
O: ObjectType,
N: Into<&'a str>,
M: Into<&'a str>,
&'a self,
source_property: N,
target: &'a O,
target_property: M
) -> BindingBuilder<'a> where
O: ObjectType,
N: Into<&'a str>,
M: Into<&'a str>,
pub fn ref_count(&self) -> u32
pub fn emit_with_values(
&self,
signal_id: SignalId,
args: &[Value]
) -> Result<Option<Value>, BoolError>
&self,
signal_id: SignalId,
args: &[Value]
) -> Result<Option<Value>, BoolError>
pub fn emit_by_name_with_values<'a, N>(
&self,
signal_name: N,
args: &[Value]
) -> Result<Option<Value>, BoolError> where
N: Into<&'a str>,
&self,
signal_name: N,
args: &[Value]
) -> Result<Option<Value>, BoolError> where
N: Into<&'a str>,
pub fn emit_with_details_and_values(
&self,
signal_id: SignalId,
details: Quark,
args: &[Value]
) -> Result<Option<Value>, BoolError>
&self,
signal_id: SignalId,
details: Quark,
args: &[Value]
) -> Result<Option<Value>, BoolError>
impl<T> ToOwned for T where
T: Clone, [src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T[src]
pub fn clone_into(&self, target: &mut T)[src]
impl<T> ToSendValue for T where
T: SetValue + Send + ToValue + ?Sized,
T: SetValue + Send + ToValue + ?Sized,
pub fn to_send_value(&self) -> SendValue
impl<T> ToString for T where
T: Display + ?Sized, [src]
T: Display + ?Sized,
impl<T> ToValue for T where
T: SetValue + ?Sized,
T: SetValue + ?Sized,
pub fn to_value(&self) -> Value
pub fn to_value_type(&self) -> Type
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]
U: TryFrom<T>,