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
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files.git)
// DO NOT EDIT
use crate::CssLocation;
use glib::object::IsA;
use glib::translate::*;
use std::fmt;
glib::wrapper! {
/// Defines a part of a CSS document.
///
/// Because sections are nested into one another, you can use
/// [`parent()`][Self::parent()] to get the containing region.
#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct CssSection(Shared<ffi::GtkCssSection>);
match fn {
ref => |ptr| ffi::gtk_css_section_ref(ptr),
unref => |ptr| ffi::gtk_css_section_unref(ptr),
type_ => || ffi::gtk_css_section_get_type(),
}
}
impl CssSection {
/// Creates a new [`CssSection`][crate::CssSection] referring to the section
/// in the given `file` from the `start` location to the
/// `end` location.
/// ## `file`
/// The file this section refers to
/// ## `start`
/// The start location
/// ## `end`
/// The end location
///
/// # Returns
///
/// a new [`CssSection`][crate::CssSection]
#[doc(alias = "gtk_css_section_new")]
pub fn new<P: IsA<gio::File>>(
file: Option<&P>,
start: &CssLocation,
end: &CssLocation,
) -> CssSection {
assert_initialized_main_thread!();
unsafe {
from_glib_full(ffi::gtk_css_section_new(
file.map(|p| p.as_ref()).to_glib_none().0,
start.to_glib_none().0,
end.to_glib_none().0,
))
}
}
/// Returns the location in the CSS document where this section ends.
///
/// # Returns
///
/// The end location of
/// this section
#[doc(alias = "gtk_css_section_get_end_location")]
#[doc(alias = "get_end_location")]
pub fn end_location(&self) -> Option<CssLocation> {
unsafe { from_glib_none(ffi::gtk_css_section_get_end_location(self.to_glib_none().0)) }
}
/// Gets the file that `self` was parsed from.
///
/// If no such file exists, for example because the CSS was loaded via
/// [``CssProvider::load_from_data()``][crate::`CssProvider::load_from_data()`], then `NULL` is returned.
///
/// # Returns
///
/// the `GFile` from which the `section`
/// was parsed
#[doc(alias = "gtk_css_section_get_file")]
#[doc(alias = "get_file")]
pub fn file(&self) -> Option<gio::File> {
unsafe { from_glib_none(ffi::gtk_css_section_get_file(self.to_glib_none().0)) }
}
/// Gets the parent section for the given `section`.
///
/// The parent section is the section that contains this `section`. A special
/// case are sections of type `GTK_CSS_SECTION_DOCUMEN`T. Their parent will
/// either be `NULL` if they are the original CSS document that was loaded by
/// [``CssProvider::load_from_file()``][crate::`CssProvider::load_from_file()`] or a section of type
/// `GTK_CSS_SECTION_IMPORT` if it was loaded with an ``import`` rule from
/// a different file.
///
/// # Returns
///
/// the parent section
#[doc(alias = "gtk_css_section_get_parent")]
#[doc(alias = "get_parent")]
pub fn parent(&self) -> Option<CssSection> {
unsafe { from_glib_none(ffi::gtk_css_section_get_parent(self.to_glib_none().0)) }
}
/// Returns the location in the CSS document where this section starts.
///
/// # Returns
///
/// The start location of
/// this section
#[doc(alias = "gtk_css_section_get_start_location")]
#[doc(alias = "get_start_location")]
pub fn start_location(&self) -> Option<CssLocation> {
unsafe {
from_glib_none(ffi::gtk_css_section_get_start_location(
self.to_glib_none().0,
))
}
}
#[doc(alias = "gtk_css_section_to_string")]
#[doc(alias = "to_string")]
pub fn to_str(&self) -> glib::GString {
unsafe { from_glib_full(ffi::gtk_css_section_to_string(self.to_glib_none().0)) }
}
}
impl fmt::Display for CssSection {
#[inline]
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str(&self.to_str())
}
}