1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT
use crate::{Expression, SortType, Sorter};
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::{boxed::Box as Box_, fmt, mem::transmute};
glib::wrapper! {
/// [`NumericSorter`][crate::NumericSorter] is a [`Sorter`][crate::Sorter] that compares numbers.
///
/// To obtain the numbers to compare, this sorter evaluates a
/// [`Expression`][crate::Expression].
///
/// ## Properties
///
///
/// #### `expression`
/// The expression to evaluate on items to get a number to compare with.
///
/// Readable | Writeable
///
///
/// #### `sort-order`
/// Whether the sorter will sort smaller numbers first.
///
/// Readable | Writeable
///
/// # Implements
///
/// [`SorterExt`][trait@crate::prelude::SorterExt], [`trait@glib::ObjectExt`]
#[doc(alias = "GtkNumericSorter")]
pub struct NumericSorter(Object<ffi::GtkNumericSorter, ffi::GtkNumericSorterClass>) @extends Sorter;
match fn {
type_ => || ffi::gtk_numeric_sorter_get_type(),
}
}
impl NumericSorter {
/// Creates a new numeric sorter using the given @expression.
///
/// Smaller numbers will be sorted first. You can call
/// [`set_sort_order()`][Self::set_sort_order()] to change this.
/// ## `expression`
/// The expression to evaluate
///
/// # Returns
///
/// a new [`NumericSorter`][crate::NumericSorter]
#[doc(alias = "gtk_numeric_sorter_new")]
pub fn new(expression: Option<impl AsRef<Expression>>) -> NumericSorter {
assert_initialized_main_thread!();
unsafe {
from_glib_full(ffi::gtk_numeric_sorter_new(
expression
.map(|p| p.as_ref().clone().upcast())
.into_glib_ptr(),
))
}
}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`NumericSorter`] objects.
///
/// This method returns an instance of [`NumericSorterBuilder`](crate::builders::NumericSorterBuilder) which can be used to create [`NumericSorter`] objects.
pub fn builder() -> NumericSorterBuilder {
NumericSorterBuilder::new()
}
/// Gets the expression that is evaluated to obtain numbers from items.
///
/// # Returns
///
/// a [`Expression`][crate::Expression]
#[doc(alias = "gtk_numeric_sorter_get_expression")]
#[doc(alias = "get_expression")]
pub fn expression(&self) -> Option<Expression> {
unsafe {
from_glib_none(ffi::gtk_numeric_sorter_get_expression(
self.to_glib_none().0,
))
}
}
/// Gets whether this sorter will sort smaller numbers first.
///
/// # Returns
///
/// the order of the numbers
#[doc(alias = "gtk_numeric_sorter_get_sort_order")]
#[doc(alias = "get_sort_order")]
pub fn sort_order(&self) -> SortType {
unsafe {
from_glib(ffi::gtk_numeric_sorter_get_sort_order(
self.to_glib_none().0,
))
}
}
/// Sets the expression that is evaluated to obtain numbers from items.
///
/// Unless an expression is set on @self, the sorter will always
/// compare items as invalid.
///
/// The expression must have a return type that can be compared
/// numerically, such as `G_TYPE_INT` or `G_TYPE_DOUBLE`.
/// ## `expression`
/// a [`Expression`][crate::Expression]
#[doc(alias = "gtk_numeric_sorter_set_expression")]
pub fn set_expression(&self, expression: Option<impl AsRef<Expression>>) {
unsafe {
ffi::gtk_numeric_sorter_set_expression(
self.to_glib_none().0,
expression.as_ref().map(|p| p.as_ref()).to_glib_none().0,
);
}
}
/// Sets whether to sort smaller numbers before larger ones.
/// ## `sort_order`
/// whether to sort smaller numbers first
#[doc(alias = "gtk_numeric_sorter_set_sort_order")]
pub fn set_sort_order(&self, sort_order: SortType) {
unsafe {
ffi::gtk_numeric_sorter_set_sort_order(self.to_glib_none().0, sort_order.into_glib());
}
}
#[doc(alias = "expression")]
pub fn connect_expression_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_expression_trampoline<F: Fn(&NumericSorter) + 'static>(
this: *mut ffi::GtkNumericSorter,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::expression\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_expression_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "sort-order")]
pub fn connect_sort_order_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_sort_order_trampoline<F: Fn(&NumericSorter) + 'static>(
this: *mut ffi::GtkNumericSorter,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::sort-order\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_sort_order_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl Default for NumericSorter {
fn default() -> Self {
glib::object::Object::new::<Self>()
}
}
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`NumericSorter`] objects.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct NumericSorterBuilder {
builder: glib::object::ObjectBuilder<'static, NumericSorter>,
}
impl NumericSorterBuilder {
fn new() -> Self {
Self {
builder: glib::object::Object::builder(),
}
}
/// The expression to evaluate on items to get a number to compare with.
pub fn expression(self, expression: impl AsRef<Expression>) -> Self {
Self {
builder: self
.builder
.property("expression", expression.as_ref().clone()),
}
}
/// Whether the sorter will sort smaller numbers first.
pub fn sort_order(self, sort_order: SortType) -> Self {
Self {
builder: self.builder.property("sort-order", sort_order),
}
}
// rustdoc-stripper-ignore-next
/// Build the [`NumericSorter`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> NumericSorter {
self.builder.build()
}
}
impl fmt::Display for NumericSorter {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("NumericSorter")
}
}