Trait poppler::prelude::AnnotMarkupExt

source · 
pub trait AnnotMarkupExt: IsA<AnnotMarkup> + Sealed + 'static {

Show 14 methods    // Provided methods
    fn date(&self) -> Option<Date> { ... }
    fn external_data(&self) -> AnnotExternalDataType { ... }
    fn label(&self) -> Option<GString> { ... }
    fn opacity(&self) -> f64 { ... }
    fn is_popup_is_open(&self) -> bool { ... }
    fn popup_rectangle(&self) -> Option<Rectangle> { ... }
    fn reply_to(&self) -> AnnotMarkupReplyType { ... }
    fn subject(&self) -> Option<GString> { ... }
    fn has_popup(&self) -> bool { ... }
    fn set_label(&self, label: Option<&str>) { ... }
    fn set_opacity(&self, opacity: f64) { ... }
    fn set_popup(&self, popup_rect: &mut Rectangle) { ... }
    fn set_popup_is_open(&self, is_open: bool) { ... }
    fn set_popup_rectangle(&self, poppler_rect: &mut Rectangle) { ... }

}
Expand description

Trait containing all AnnotMarkup methods.

Implementors

AnnotCircle, AnnotFileAttachment, AnnotFreeText, AnnotMarkup

Provided Methods§

source

fn date(&self) -> Option<Date>

Returns the date and time when the annotation was created

Returns

a [glib::Date][crate::glib::Date] representing the date and time when the annotation was created, or None

source

fn external_data(&self) -> AnnotExternalDataType

Gets the external data type of self.

Returns

AnnotExternalDataType of self.

source

fn label(&self) -> Option<GString>

Retrieves the label text of self.

Returns

the label text of self.

source

fn opacity(&self) -> f64

Retrieves the opacity value of self.

Returns

the opacity value of self, between 0 (transparent) and 1 (opaque)

source

fn is_popup_is_open(&self) -> bool

Retrieves the state of the popup window related to self.

Returns

the state of self. true if it’s open, false in other case.

source

fn popup_rectangle(&self) -> Option<Rectangle>

Retrieves the rectangle of the popup window related to self.

Returns

true if Rectangle was correctly filled, false otherwise

poppler_rect

a Rectangle to store the popup rectangle

source

fn reply_to(&self) -> AnnotMarkupReplyType

Gets the reply type of self.

Returns

AnnotMarkupReplyType of self.

source

fn subject(&self) -> Option<GString>

Retrives the subject text of self.

Returns

the subject text of self.

source

fn has_popup(&self) -> bool

Return true if the markup annotation has a popup window associated

Returns

true, if self has popup, false otherwise

source

fn set_label(&self, label: Option<&str>)

Sets the label text of self, replacing the current one

label

a text string containing the new label, or None

source

fn set_opacity(&self, opacity: f64)

Sets the opacity of self. This value applies to all visible elements of self in its closed state, but not to the pop-up window that appears when it’s openened

opacity

a constant opacity value, between 0 (transparent) and 1 (opaque)

source

fn set_popup(&self, popup_rect: &mut Rectangle)

Associates a new popup window for editing contents of self. Popup window shall be displayed by viewers at popup_rect on the page.

a Rectangle

source

fn set_popup_is_open(&self, is_open: bool)

Sets the state of the popup window related to self.

is_open

whether popup window should initially be displayed open

source

fn set_popup_rectangle(&self, poppler_rect: &mut Rectangle)

Sets the rectangle of the popup window related to self. This doesn’t have any effect if self doesn’t have a popup associated, use set_popup() to associate a popup window to a AnnotMarkup.

poppler_rect

a Rectangle to set

Implementors§