gtk4/auto/constraint.rs
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
// 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::{ffi, ConstraintAttribute, ConstraintRelation, ConstraintTarget};
use glib::{prelude::*, translate::*};
glib::wrapper! {
/// [`Constraint`][crate::Constraint] describes a constraint between attributes of two widgets,
/// expressed as a linear equation.
///
/// The typical equation for a constraint is:
///
/// ```text
/// target.target_attr = source.source_attr × multiplier + constant
/// ```
///
/// Each [`Constraint`][crate::Constraint] is part of a system that will be solved by a
/// [`ConstraintLayout`][crate::ConstraintLayout] in order to allocate and position each
/// child widget or guide.
///
/// The source and target, as well as their attributes, of a [`Constraint`][crate::Constraint]
/// instance are immutable after creation.
///
/// ## Properties
///
///
/// #### `constant`
/// The constant value to be added to the [`source-attribute`][struct@crate::Constraint#source-attribute].
///
/// Readable | Writeable | Construct Only
///
///
/// #### `multiplier`
/// The multiplication factor to be applied to
/// the [`source-attribute`][struct@crate::Constraint#source-attribute].
///
/// Readable | Writeable | Construct Only
///
///
/// #### `relation`
/// The order relation between the terms of the constraint.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `source`
/// The source of the constraint.
///
/// The constraint will set the [`target-attribute`][struct@crate::Constraint#target-attribute]
/// property of the target using the [`source-attribute`][struct@crate::Constraint#source-attribute]
/// property of the source.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `source-attribute`
/// The attribute of the [`source`][struct@crate::Constraint#source] read by the
/// constraint.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `strength`
/// The strength of the constraint.
///
/// The strength can be expressed either using one of the symbolic values
/// of the [`ConstraintStrength`][crate::ConstraintStrength] enumeration, or any positive integer
/// value.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `target`
/// The target of the constraint.
///
/// The constraint will set the [`target-attribute`][struct@crate::Constraint#target-attribute]
/// property of the target using the [`source-attribute`][struct@crate::Constraint#source-attribute]
/// property of the source widget.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `target-attribute`
/// The attribute of the [`target`][struct@crate::Constraint#target] set by the constraint.
///
/// Readable | Writeable | Construct Only
///
/// # Implements
///
/// [`trait@glib::ObjectExt`]
#[doc(alias = "GtkConstraint")]
pub struct Constraint(Object<ffi::GtkConstraint, ffi::GtkConstraintClass>);
match fn {
type_ => || ffi::gtk_constraint_get_type(),
}
}
impl Constraint {
/// Creates a new constraint representing a relation between a layout
/// attribute on a source and a layout attribute on a target.
/// ## `target`
/// the target of the constraint
/// ## `target_attribute`
/// the attribute of `target` to be set
/// ## `relation`
/// the relation equivalence between `target_attribute` and `source_attribute`
/// ## `source`
/// the source of the constraint
/// ## `source_attribute`
/// the attribute of `source` to be read
/// ## `multiplier`
/// a multiplication factor to be applied to `source_attribute`
/// ## `constant`
/// a constant factor to be added to `source_attribute`
/// ## `strength`
/// the strength of the constraint
///
/// # Returns
///
/// the newly created constraint
#[doc(alias = "gtk_constraint_new")]
pub fn new(
target: Option<&impl IsA<ConstraintTarget>>,
target_attribute: ConstraintAttribute,
relation: ConstraintRelation,
source: Option<&impl IsA<ConstraintTarget>>,
source_attribute: ConstraintAttribute,
multiplier: f64,
constant: f64,
strength: i32,
) -> Constraint {
assert_initialized_main_thread!();
unsafe {
from_glib_full(ffi::gtk_constraint_new(
target.map(|p| p.as_ref()).to_glib_none().0,
target_attribute.into_glib(),
relation.into_glib(),
source.map(|p| p.as_ref()).to_glib_none().0,
source_attribute.into_glib(),
multiplier,
constant,
strength,
))
}
}
/// Creates a new constraint representing a relation between a layout
/// attribute on a target and a constant value.
/// ## `target`
/// a the target of the constraint
/// ## `target_attribute`
/// the attribute of `target` to be set
/// ## `relation`
/// the relation equivalence between `target_attribute` and `constant`
/// ## `constant`
/// a constant factor to be set on `target_attribute`
/// ## `strength`
/// the strength of the constraint
///
/// # Returns
///
/// the newly created constraint
#[doc(alias = "gtk_constraint_new_constant")]
pub fn new_constant(
target: Option<&impl IsA<ConstraintTarget>>,
target_attribute: ConstraintAttribute,
relation: ConstraintRelation,
constant: f64,
strength: i32,
) -> Constraint {
assert_initialized_main_thread!();
unsafe {
from_glib_full(ffi::gtk_constraint_new_constant(
target.map(|p| p.as_ref()).to_glib_none().0,
target_attribute.into_glib(),
relation.into_glib(),
constant,
strength,
))
}
}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`Constraint`] objects.
///
/// This method returns an instance of [`ConstraintBuilder`](crate::builders::ConstraintBuilder) which can be used to create [`Constraint`] objects.
pub fn builder() -> ConstraintBuilder {
ConstraintBuilder::new()
}
/// Retrieves the constant factor added to the source attributes' value.
///
/// # Returns
///
/// a constant factor
#[doc(alias = "gtk_constraint_get_constant")]
#[doc(alias = "get_constant")]
pub fn constant(&self) -> f64 {
unsafe { ffi::gtk_constraint_get_constant(self.to_glib_none().0) }
}
/// Retrieves the multiplication factor applied to the source
/// attribute's value.
///
/// # Returns
///
/// a multiplication factor
#[doc(alias = "gtk_constraint_get_multiplier")]
#[doc(alias = "get_multiplier")]
pub fn multiplier(&self) -> f64 {
unsafe { ffi::gtk_constraint_get_multiplier(self.to_glib_none().0) }
}
/// The order relation between the terms of the constraint.
///
/// # Returns
///
/// a relation type
#[doc(alias = "gtk_constraint_get_relation")]
#[doc(alias = "get_relation")]
pub fn relation(&self) -> ConstraintRelation {
unsafe { from_glib(ffi::gtk_constraint_get_relation(self.to_glib_none().0)) }
}
/// Retrieves the [`ConstraintTarget`][crate::ConstraintTarget] used as the source for the
/// constraint.
///
/// If the source is set to `NULL` at creation, the constraint will use
/// the widget using the [`ConstraintLayout`][crate::ConstraintLayout] as the source.
///
/// # Returns
///
/// the source of the constraint
#[doc(alias = "gtk_constraint_get_source")]
#[doc(alias = "get_source")]
pub fn source(&self) -> Option<ConstraintTarget> {
unsafe { from_glib_none(ffi::gtk_constraint_get_source(self.to_glib_none().0)) }
}
/// Retrieves the attribute of the source to be read by the constraint.
///
/// # Returns
///
/// the source's attribute
#[doc(alias = "gtk_constraint_get_source_attribute")]
#[doc(alias = "get_source_attribute")]
#[doc(alias = "source-attribute")]
pub fn source_attribute(&self) -> ConstraintAttribute {
unsafe {
from_glib(ffi::gtk_constraint_get_source_attribute(
self.to_glib_none().0,
))
}
}
/// Retrieves the strength of the constraint.
///
/// # Returns
///
/// the strength value
#[doc(alias = "gtk_constraint_get_strength")]
#[doc(alias = "get_strength")]
pub fn strength(&self) -> i32 {
unsafe { ffi::gtk_constraint_get_strength(self.to_glib_none().0) }
}
/// Retrieves the [`ConstraintTarget`][crate::ConstraintTarget] used as the target for
/// the constraint.
///
/// If the targe is set to `NULL` at creation, the constraint will use
/// the widget using the [`ConstraintLayout`][crate::ConstraintLayout] as the target.
///
/// # Returns
///
/// a [`ConstraintTarget`][crate::ConstraintTarget]
#[doc(alias = "gtk_constraint_get_target")]
#[doc(alias = "get_target")]
pub fn target(&self) -> Option<ConstraintTarget> {
unsafe { from_glib_none(ffi::gtk_constraint_get_target(self.to_glib_none().0)) }
}
/// Retrieves the attribute of the target to be set by the constraint.
///
/// # Returns
///
/// the target's attribute
#[doc(alias = "gtk_constraint_get_target_attribute")]
#[doc(alias = "get_target_attribute")]
#[doc(alias = "target-attribute")]
pub fn target_attribute(&self) -> ConstraintAttribute {
unsafe {
from_glib(ffi::gtk_constraint_get_target_attribute(
self.to_glib_none().0,
))
}
}
/// Checks whether the constraint is attached to a [`ConstraintLayout`][crate::ConstraintLayout],
/// and it is contributing to the layout.
///
/// # Returns
///
/// `TRUE` if the constraint is attached
#[doc(alias = "gtk_constraint_is_attached")]
pub fn is_attached(&self) -> bool {
unsafe { from_glib(ffi::gtk_constraint_is_attached(self.to_glib_none().0)) }
}
/// Checks whether the constraint describes a relation between an attribute
/// on the [`target`][struct@crate::Constraint#target] and a constant value.
///
/// # Returns
///
/// `TRUE` if the constraint is a constant relation
#[doc(alias = "gtk_constraint_is_constant")]
pub fn is_constant(&self) -> bool {
unsafe { from_glib(ffi::gtk_constraint_is_constant(self.to_glib_none().0)) }
}
/// Checks whether the constraint is a required relation for solving the
/// constraint layout.
///
/// # Returns
///
/// [`true`] if the constraint is required
#[doc(alias = "gtk_constraint_is_required")]
pub fn is_required(&self) -> bool {
unsafe { from_glib(ffi::gtk_constraint_is_required(self.to_glib_none().0)) }
}
}
impl Default for Constraint {
fn default() -> Self {
glib::object::Object::new::<Self>()
}
}
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`Constraint`] 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 ConstraintBuilder {
builder: glib::object::ObjectBuilder<'static, Constraint>,
}
impl ConstraintBuilder {
fn new() -> Self {
Self {
builder: glib::object::Object::builder(),
}
}
/// The constant value to be added to the [`source-attribute`][struct@crate::Constraint#source-attribute].
pub fn constant(self, constant: f64) -> Self {
Self {
builder: self.builder.property("constant", constant),
}
}
/// The multiplication factor to be applied to
/// the [`source-attribute`][struct@crate::Constraint#source-attribute].
pub fn multiplier(self, multiplier: f64) -> Self {
Self {
builder: self.builder.property("multiplier", multiplier),
}
}
/// The order relation between the terms of the constraint.
pub fn relation(self, relation: ConstraintRelation) -> Self {
Self {
builder: self.builder.property("relation", relation),
}
}
/// The source of the constraint.
///
/// The constraint will set the [`target-attribute`][struct@crate::Constraint#target-attribute]
/// property of the target using the [`source-attribute`][struct@crate::Constraint#source-attribute]
/// property of the source.
pub fn source(self, source: &impl IsA<ConstraintTarget>) -> Self {
Self {
builder: self.builder.property("source", source.clone().upcast()),
}
}
/// The attribute of the [`source`][struct@crate::Constraint#source] read by the
/// constraint.
pub fn source_attribute(self, source_attribute: ConstraintAttribute) -> Self {
Self {
builder: self.builder.property("source-attribute", source_attribute),
}
}
/// The strength of the constraint.
///
/// The strength can be expressed either using one of the symbolic values
/// of the [`ConstraintStrength`][crate::ConstraintStrength] enumeration, or any positive integer
/// value.
pub fn strength(self, strength: i32) -> Self {
Self {
builder: self.builder.property("strength", strength),
}
}
/// The target of the constraint.
///
/// The constraint will set the [`target-attribute`][struct@crate::Constraint#target-attribute]
/// property of the target using the [`source-attribute`][struct@crate::Constraint#source-attribute]
/// property of the source widget.
pub fn target(self, target: &impl IsA<ConstraintTarget>) -> Self {
Self {
builder: self.builder.property("target", target.clone().upcast()),
}
}
/// The attribute of the [`target`][struct@crate::Constraint#target] set by the constraint.
pub fn target_attribute(self, target_attribute: ConstraintAttribute) -> Self {
Self {
builder: self.builder.property("target-attribute", target_attribute),
}
}
// rustdoc-stripper-ignore-next
/// Build the [`Constraint`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> Constraint {
self.builder.build()
}
}