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 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
// 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::Window;
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::{boxed::Box as Box_, fmt, mem::transmute, pin::Pin, ptr};
glib::wrapper! {
/// A [`ColorDialog`][crate::ColorDialog] object collects the arguments that
/// are needed to present a color chooser dialog to the
/// user, such as a title for the dialog and whether it
/// should be modal.
///
/// The dialog is shown with the [`choose_rgba()`][Self::choose_rgba()]
/// function. This API follows the GIO async pattern, and the
/// result can be obtained by calling
/// `Gtk::ColorDialog::choose_rgba_finish()`.
///
/// See [`ColorDialogButton`][crate::ColorDialogButton] for a convenient control
/// that uses [`ColorDialog`][crate::ColorDialog] and presents the results.
///
/// ## Properties
///
///
/// #### `modal`
/// Whether the color chooser dialog is modal.
///
/// Readable | Writeable
///
///
/// #### `title`
/// A title that may be shown on the color chooser
/// dialog that is presented by [`ColorDialog::choose_rgba()`][crate::ColorDialog::choose_rgba()].
///
/// Readable | Writeable
///
///
/// #### `with-alpha`
/// Whether colors may have alpha (translucency).
///
/// When with-alpha is [`false`], the color that is selected
/// will be forced to have alpha == 1.
///
/// Readable | Writeable
///
/// # Implements
///
/// [`trait@glib::ObjectExt`]
#[doc(alias = "GtkColorDialog")]
pub struct ColorDialog(Object<ffi::GtkColorDialog, ffi::GtkColorDialogClass>);
match fn {
type_ => || ffi::gtk_color_dialog_get_type(),
}
}
impl ColorDialog {
/// Creates a new [`ColorDialog`][crate::ColorDialog] object.
///
/// # Returns
///
/// the new [`ColorDialog`][crate::ColorDialog]
#[doc(alias = "gtk_color_dialog_new")]
pub fn new() -> ColorDialog {
assert_initialized_main_thread!();
unsafe { from_glib_full(ffi::gtk_color_dialog_new()) }
}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`ColorDialog`] objects.
///
/// This method returns an instance of [`ColorDialogBuilder`](crate::builders::ColorDialogBuilder) which can be used to create [`ColorDialog`] objects.
pub fn builder() -> ColorDialogBuilder {
ColorDialogBuilder::new()
}
/// This function initiates a color choice operation by
/// presenting a color chooser dialog to the user.
///
/// The @callback will be called when the dialog is dismissed.
/// It should call `Gtk::ColorDialog::choose_rgba_finish()`
/// to obtain the result.
/// ## `parent`
/// the parent [`Window`][crate::Window]
/// ## `initial_color`
/// the color to select initially
/// ## `cancellable`
/// a `GCancellable` to cancel the operation
/// ## `callback`
/// a callback to call when the operation is complete
#[doc(alias = "gtk_color_dialog_choose_rgba")]
pub fn choose_rgba<P: FnOnce(Result<gdk::RGBA, glib::Error>) + 'static>(
&self,
parent: Option<&impl IsA<Window>>,
initial_color: Option<&gdk::RGBA>,
cancellable: Option<&impl IsA<gio::Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn choose_rgba_trampoline<
P: FnOnce(Result<gdk::RGBA, glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut gio::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = ptr::null_mut();
let ret =
ffi::gtk_color_dialog_choose_rgba_finish(_source_object as *mut _, res, &mut error);
let result = if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = choose_rgba_trampoline::<P>;
unsafe {
ffi::gtk_color_dialog_choose_rgba(
self.to_glib_none().0,
parent.map(|p| p.as_ref()).to_glib_none().0,
initial_color.to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
pub fn choose_rgba_future(
&self,
parent: Option<&(impl IsA<Window> + Clone + 'static)>,
initial_color: Option<&gdk::RGBA>,
) -> Pin<Box_<dyn std::future::Future<Output = Result<gdk::RGBA, glib::Error>> + 'static>> {
let parent = parent.map(ToOwned::to_owned);
let initial_color = initial_color.map(ToOwned::to_owned);
Box_::pin(gio::GioFuture::new(self, move |obj, cancellable, send| {
obj.choose_rgba(
parent.as_ref().map(::std::borrow::Borrow::borrow),
initial_color.as_ref().map(::std::borrow::Borrow::borrow),
Some(cancellable),
move |res| {
send.resolve(res);
},
);
}))
}
/// Returns whether the color chooser dialog
/// blocks interaction with the parent window
/// while it is presented.
///
/// # Returns
///
/// `TRUE` if the color chooser dialog is modal
#[doc(alias = "gtk_color_dialog_get_modal")]
#[doc(alias = "get_modal")]
pub fn is_modal(&self) -> bool {
unsafe { from_glib(ffi::gtk_color_dialog_get_modal(self.to_glib_none().0)) }
}
/// Returns the title that will be shown on the
/// color chooser dialog.
///
/// # Returns
///
/// the title
#[doc(alias = "gtk_color_dialog_get_title")]
#[doc(alias = "get_title")]
pub fn title(&self) -> glib::GString {
unsafe { from_glib_none(ffi::gtk_color_dialog_get_title(self.to_glib_none().0)) }
}
/// Returns whether colors may have alpha.
///
/// # Returns
///
/// `TRUE` if colors may have alpha
#[doc(alias = "gtk_color_dialog_get_with_alpha")]
#[doc(alias = "get_with_alpha")]
pub fn is_with_alpha(&self) -> bool {
unsafe { from_glib(ffi::gtk_color_dialog_get_with_alpha(self.to_glib_none().0)) }
}
/// Sets whether the color chooser dialog
/// blocks interaction with the parent window
/// while it is presented.
/// ## `modal`
/// the new value
#[doc(alias = "gtk_color_dialog_set_modal")]
pub fn set_modal(&self, modal: bool) {
unsafe {
ffi::gtk_color_dialog_set_modal(self.to_glib_none().0, modal.into_glib());
}
}
/// Sets the title that will be shown on the
/// color chooser dialog.
/// ## `title`
/// the new title
#[doc(alias = "gtk_color_dialog_set_title")]
pub fn set_title(&self, title: &str) {
unsafe {
ffi::gtk_color_dialog_set_title(self.to_glib_none().0, title.to_glib_none().0);
}
}
/// Sets whether colors may have alpha.
/// ## `with_alpha`
/// the new value
#[doc(alias = "gtk_color_dialog_set_with_alpha")]
pub fn set_with_alpha(&self, with_alpha: bool) {
unsafe {
ffi::gtk_color_dialog_set_with_alpha(self.to_glib_none().0, with_alpha.into_glib());
}
}
#[cfg(any(feature = "v4_10", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_10")))]
#[doc(alias = "modal")]
pub fn connect_modal_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_modal_trampoline<F: Fn(&ColorDialog) + 'static>(
this: *mut ffi::GtkColorDialog,
_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::modal\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_modal_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[cfg(any(feature = "v4_10", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_10")))]
#[doc(alias = "title")]
pub fn connect_title_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_title_trampoline<F: Fn(&ColorDialog) + 'static>(
this: *mut ffi::GtkColorDialog,
_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::title\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_title_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[cfg(any(feature = "v4_10", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_10")))]
#[doc(alias = "with-alpha")]
pub fn connect_with_alpha_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_with_alpha_trampoline<F: Fn(&ColorDialog) + 'static>(
this: *mut ffi::GtkColorDialog,
_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::with-alpha\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_with_alpha_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
#[cfg(any(feature = "v4_10", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_10")))]
impl Default for ColorDialog {
fn default() -> Self {
Self::new()
}
}
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`ColorDialog`] 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 ColorDialogBuilder {
builder: glib::object::ObjectBuilder<'static, ColorDialog>,
}
impl ColorDialogBuilder {
fn new() -> Self {
Self {
builder: glib::object::Object::builder(),
}
}
/// Whether the color chooser dialog is modal.
#[cfg(any(feature = "v4_10", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_10")))]
pub fn modal(self, modal: bool) -> Self {
Self {
builder: self.builder.property("modal", modal),
}
}
/// A title that may be shown on the color chooser
/// dialog that is presented by [`ColorDialog::choose_rgba()`][crate::ColorDialog::choose_rgba()].
#[cfg(any(feature = "v4_10", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_10")))]
pub fn title(self, title: impl Into<glib::GString>) -> Self {
Self {
builder: self.builder.property("title", title.into()),
}
}
/// Whether colors may have alpha (translucency).
///
/// When with-alpha is [`false`], the color that is selected
/// will be forced to have alpha == 1.
#[cfg(any(feature = "v4_10", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v4_10")))]
pub fn with_alpha(self, with_alpha: bool) -> Self {
Self {
builder: self.builder.property("with-alpha", with_alpha),
}
}
// rustdoc-stripper-ignore-next
/// Build the [`ColorDialog`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> ColorDialog {
self.builder.build()
}
}
impl fmt::Display for ColorDialog {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("ColorDialog")
}
}