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 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
// 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::{Accessible, Buildable, ConstraintTarget, Widget};
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::{boxed::Box as Box_, fmt, mem::transmute};
glib::wrapper! {
/// The [`Actionable`][crate::Actionable] interface provides a convenient way of asscociating
/// widgets with actions.
///
/// It primarily consists of two properties: [`action-name`][struct@crate::Actionable#action-name]
/// and [`action-target`][struct@crate::Actionable#action-target]. There are also some convenience
/// APIs for setting these properties.
///
/// The action will be looked up in action groups that are found among
/// the widgets ancestors. Most commonly, these will be the actions with
/// the “win.” or “app.” prefix that are associated with the
/// [`ApplicationWindow`][crate::ApplicationWindow] or [`Application`][crate::Application], but other action groups that
/// are added with [`WidgetExt::insert_action_group()`][crate::prelude::WidgetExt::insert_action_group()] will be consulted
/// as well.
///
/// ## Properties
///
///
/// #### `action-name`
/// Readable | Writeable
///
///
/// #### `action-target`
/// Readable | Writeable
/// <details><summary><h4>Widget</h4></summary>
///
///
/// #### `can-focus`
/// Whether the widget or any of its descendents can accept
/// the input focus.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
///
/// Readable | Writeable
///
///
/// #### `can-target`
/// Whether the widget can receive pointer events.
///
/// Readable | Writeable
///
///
/// #### `css-classes`
/// A list of css classes applied to this widget.
///
/// Readable | Writeable
///
///
/// #### `css-name`
/// The name of this widget in the CSS tree.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `cursor`
/// The cursor used by @widget.
///
/// Readable | Writeable
///
///
/// #### `focus-on-click`
/// Whether the widget should grab focus when it is clicked with the mouse.
///
/// This property is only relevant for widgets that can take focus.
///
/// Readable | Writeable
///
///
/// #### `focusable`
/// Whether this widget itself will accept the input focus.
///
/// Readable | Writeable
///
///
/// #### `halign`
/// How to distribute horizontal space if widget gets extra space.
///
/// Readable | Writeable
///
///
/// #### `has-default`
/// Whether the widget is the default widget.
///
/// Readable
///
///
/// #### `has-focus`
/// Whether the widget has the input focus.
///
/// Readable
///
///
/// #### `has-tooltip`
/// Enables or disables the emission of the ::query-tooltip signal on @widget.
///
/// A value of [`true`] indicates that @widget can have a tooltip, in this case
/// the widget will be queried using [`query-tooltip`][struct@crate::Widget#query-tooltip] to
/// determine whether it will provide a tooltip or not.
///
/// Readable | Writeable
///
///
/// #### `height-request`
/// Override for height request of the widget.
///
/// If this is -1, the natural request will be used.
///
/// Readable | Writeable
///
///
/// #### `hexpand`
/// Whether to expand horizontally.
///
/// Readable | Writeable
///
///
/// #### `hexpand-set`
/// Whether to use the `hexpand` property.
///
/// Readable | Writeable
///
///
/// #### `layout-manager`
/// The [`LayoutManager`][crate::LayoutManager] instance to use to compute the preferred size
/// of the widget, and allocate its children.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
///
/// Readable | Writeable
///
///
/// #### `margin-bottom`
/// Margin on bottom side of widget.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
///
/// Readable | Writeable
///
///
/// #### `margin-end`
/// Margin on end of widget, horizontally.
///
/// This property supports left-to-right and right-to-left text
/// directions.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
///
/// Readable | Writeable
///
///
/// #### `margin-start`
/// Margin on start of widget, horizontally.
///
/// This property supports left-to-right and right-to-left text
/// directions.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
///
/// Readable | Writeable
///
///
/// #### `margin-top`
/// Margin on top side of widget.
///
/// This property adds margin outside of the widget's normal size
/// request, the margin will be added in addition to the size from
/// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
///
/// Readable | Writeable
///
///
/// #### `name`
/// The name of the widget.
///
/// Readable | Writeable
///
///
/// #### `opacity`
/// The requested opacity of the widget.
///
/// Readable | Writeable
///
///
/// #### `overflow`
/// How content outside the widget's content area is treated.
///
/// This property is meant to be set by widget implementations,
/// typically in their instance init function.
///
/// Readable | Writeable
///
///
/// #### `parent`
/// The parent widget of this widget.
///
/// Readable
///
///
/// #### `receives-default`
/// Whether the widget will receive the default action when it is focused.
///
/// Readable | Writeable
///
///
/// #### `root`
/// The [`Root`][crate::Root] widget of the widget tree containing this widget.
///
/// This will be [`None`] if the widget is not contained in a root widget.
///
/// Readable
///
///
/// #### `scale-factor`
/// The scale factor of the widget.
///
/// Readable
///
///
/// #### `sensitive`
/// Whether the widget responds to input.
///
/// Readable | Writeable
///
///
/// #### `tooltip-markup`
/// Sets the text of tooltip to be the given string, which is marked up
/// with Pango markup.
///
/// Also see [`Tooltip::set_markup()`][crate::Tooltip::set_markup()].
///
/// This is a convenience property which will take care of getting the
/// tooltip shown if the given string is not [`None`]:
/// [`has-tooltip`][struct@crate::Widget#has-tooltip] will automatically be set to [`true`]
/// and there will be taken care of [`query-tooltip`][struct@crate::Widget#query-tooltip] in
/// the default signal handler.
///
/// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and
/// [`tooltip-markup`][struct@crate::Widget#tooltip-markup] are set, the last one wins.
///
/// Readable | Writeable
///
///
/// #### `tooltip-text`
/// Sets the text of tooltip to be the given string.
///
/// Also see [`Tooltip::set_text()`][crate::Tooltip::set_text()].
///
/// This is a convenience property which will take care of getting the
/// tooltip shown if the given string is not [`None`]:
/// [`has-tooltip`][struct@crate::Widget#has-tooltip] will automatically be set to [`true`]
/// and there will be taken care of [`query-tooltip`][struct@crate::Widget#query-tooltip] in
/// the default signal handler.
///
/// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and
/// [`tooltip-markup`][struct@crate::Widget#tooltip-markup] are set, the last one wins.
///
/// Readable | Writeable
///
///
/// #### `valign`
/// How to distribute vertical space if widget gets extra space.
///
/// Readable | Writeable
///
///
/// #### `vexpand`
/// Whether to expand vertically.
///
/// Readable | Writeable
///
///
/// #### `vexpand-set`
/// Whether to use the `vexpand` property.
///
/// Readable | Writeable
///
///
/// #### `visible`
/// Whether the widget is visible.
///
/// Readable | Writeable
///
///
/// #### `width-request`
/// Override for width request of the widget.
///
/// If this is -1, the natural request will be used.
///
/// Readable | Writeable
/// </details>
/// <details><summary><h4>Accessible</h4></summary>
///
///
/// #### `accessible-role`
/// The accessible role of the given [`Accessible`][crate::Accessible] implementation.
///
/// The accessible role cannot be changed once set.
///
/// Readable | Writeable
/// </details>
///
/// # Implements
///
/// [`ActionableExt`][trait@crate::prelude::ActionableExt], [`WidgetExt`][trait@crate::prelude::WidgetExt], [`trait@glib::ObjectExt`], [`AccessibleExt`][trait@crate::prelude::AccessibleExt], [`BuildableExt`][trait@crate::prelude::BuildableExt], [`ConstraintTargetExt`][trait@crate::prelude::ConstraintTargetExt], [`ActionableExtManual`][trait@crate::prelude::ActionableExtManual], [`WidgetExtManual`][trait@crate::prelude::WidgetExtManual], [`AccessibleExtManual`][trait@crate::prelude::AccessibleExtManual]
#[doc(alias = "GtkActionable")]
pub struct Actionable(Interface<ffi::GtkActionable, ffi::GtkActionableInterface>) @requires Widget, Accessible, Buildable, ConstraintTarget;
match fn {
type_ => || ffi::gtk_actionable_get_type(),
}
}
impl Actionable {
pub const NONE: Option<&'static Actionable> = None;
}
/// Trait containing all [`struct@Actionable`] methods.
///
/// # Implementors
///
/// [`Actionable`][struct@crate::Actionable], [`Button`][struct@crate::Button], [`CheckButton`][struct@crate::CheckButton], [`LinkButton`][struct@crate::LinkButton], [`ListBoxRow`][struct@crate::ListBoxRow], [`LockButton`][struct@crate::LockButton], [`Switch`][struct@crate::Switch], [`ToggleButton`][struct@crate::ToggleButton]
pub trait ActionableExt: 'static {
/// Gets the action name for @self.
///
/// # Returns
///
/// the action name
#[doc(alias = "gtk_actionable_get_action_name")]
#[doc(alias = "get_action_name")]
fn action_name(&self) -> Option<glib::GString>;
/// Gets the current target value of @self.
///
/// # Returns
///
/// the current target value
#[doc(alias = "gtk_actionable_get_action_target_value")]
#[doc(alias = "get_action_target_value")]
fn action_target_value(&self) -> Option<glib::Variant>;
/// Specifies the name of the action with which this widget should be
/// associated.
///
/// If @action_name is [`None`] then the widget will be unassociated from
/// any previous action.
///
/// Usually this function is used when the widget is located (or will be
/// located) within the hierarchy of a [`ApplicationWindow`][crate::ApplicationWindow].
///
/// Names are of the form “win.save” or “app.quit” for actions on the
/// containing [`ApplicationWindow`][crate::ApplicationWindow] or its associated [`Application`][crate::Application],
/// respectively. This is the same form used for actions in the [`gio::Menu`][crate::gio::Menu]
/// associated with the window.
/// ## `action_name`
/// an action name
#[doc(alias = "gtk_actionable_set_action_name")]
fn set_action_name(&self, action_name: Option<&str>);
/// Sets the target value of an actionable widget.
///
/// If @target_value is [`None`] then the target value is unset.
///
/// The target value has two purposes. First, it is used as the parameter
/// to activation of the action associated with the [`Actionable`][crate::Actionable] widget.
/// Second, it is used to determine if the widget should be rendered as
/// “active” — the widget is active if the state is equal to the given target.
///
/// Consider the example of associating a set of buttons with a [`gio::Action`][crate::gio::Action]
/// with string state in a typical “radio button” situation. Each button
/// will be associated with the same action, but with a different target
/// value for that action. Clicking on a particular button will activate
/// the action with the target of that button, which will typically cause
/// the action’s state to change to that value. Since the action’s state
/// is now equal to the target value of the button, the button will now
/// be rendered as active (and the other buttons, with different targets,
/// rendered inactive).
/// ## `target_value`
/// a [`glib::Variant`][struct@crate::glib::Variant] to set as the target value
#[doc(alias = "gtk_actionable_set_action_target_value")]
fn set_action_target_value(&self, target_value: Option<&glib::Variant>);
/// Sets the action-name and associated string target value of an
/// actionable widget.
///
/// @detailed_action_name is a string in the format accepted by
/// [`gio::Action::parse_detailed_name()`][crate::gio::Action::parse_detailed_name()].
/// ## `detailed_action_name`
/// the detailed action name
#[doc(alias = "gtk_actionable_set_detailed_action_name")]
fn set_detailed_action_name(&self, detailed_action_name: &str);
#[doc(alias = "action-name")]
fn connect_action_name_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId;
#[doc(alias = "action-target")]
fn connect_action_target_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId;
}
impl<O: IsA<Actionable>> ActionableExt for O {
fn action_name(&self) -> Option<glib::GString> {
unsafe {
from_glib_none(ffi::gtk_actionable_get_action_name(
self.as_ref().to_glib_none().0,
))
}
}
fn action_target_value(&self) -> Option<glib::Variant> {
unsafe {
from_glib_none(ffi::gtk_actionable_get_action_target_value(
self.as_ref().to_glib_none().0,
))
}
}
fn set_action_name(&self, action_name: Option<&str>) {
unsafe {
ffi::gtk_actionable_set_action_name(
self.as_ref().to_glib_none().0,
action_name.to_glib_none().0,
);
}
}
fn set_action_target_value(&self, target_value: Option<&glib::Variant>) {
unsafe {
ffi::gtk_actionable_set_action_target_value(
self.as_ref().to_glib_none().0,
target_value.to_glib_none().0,
);
}
}
fn set_detailed_action_name(&self, detailed_action_name: &str) {
unsafe {
ffi::gtk_actionable_set_detailed_action_name(
self.as_ref().to_glib_none().0,
detailed_action_name.to_glib_none().0,
);
}
}
fn connect_action_name_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_action_name_trampoline<
P: IsA<Actionable>,
F: Fn(&P) + 'static,
>(
this: *mut ffi::GtkActionable,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(Actionable::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::action-name\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_action_name_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
fn connect_action_target_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_action_target_trampoline<
P: IsA<Actionable>,
F: Fn(&P) + 'static,
>(
this: *mut ffi::GtkActionable,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(Actionable::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::action-target\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_action_target_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl fmt::Display for Actionable {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("Actionable")
}
}