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

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files.git)
// from webkit2gtk-gir-files
// DO NOT EDIT

#[cfg(any(feature = "v2_30", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v2_30")))]
use crate::WebsitePolicies;
use glib::object::IsA;
use glib::translate::*;
use std::fmt;

glib::wrapper! {
    /// A pending policy decision.
    ///
    /// Often WebKit allows the client to decide the policy for certain
    /// operations. For instance, a client may want to open a link in a new
    /// tab, block a navigation entirely, query the user or trigger a download
    /// instead of a navigation. In these cases WebKit will fire the
    /// `signal::WebView::decide-policy` signal with a [`PolicyDecision`][crate::PolicyDecision]
    /// object. If the signal handler does nothing, WebKit will act as if
    /// [`PolicyDecisionExt::use_()`][crate::prelude::PolicyDecisionExt::use_()] was called as soon as signal handling
    /// completes. To make a policy decision asynchronously, simply increment
    /// the reference count of the [`PolicyDecision`][crate::PolicyDecision] object.
    ///
    /// This is an Abstract Base Class, you cannot instantiate it.
    ///
    /// # Implements
    ///
    /// [`PolicyDecisionExt`][trait@crate::prelude::PolicyDecisionExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "WebKitPolicyDecision")]
    pub struct PolicyDecision(Object<ffi::WebKitPolicyDecision, ffi::WebKitPolicyDecisionClass>);

    match fn {
        type_ => || ffi::webkit_policy_decision_get_type(),
    }
}

impl PolicyDecision {
    pub const NONE: Option<&'static PolicyDecision> = None;
}

/// Trait containing all [`struct@PolicyDecision`] methods.
///
/// # Implementors
///
/// [`NavigationPolicyDecision`][struct@crate::NavigationPolicyDecision], [`PolicyDecision`][struct@crate::PolicyDecision], [`ResponsePolicyDecision`][struct@crate::ResponsePolicyDecision]
pub trait PolicyDecisionExt: 'static {
    /// Spawn a download from this decision.
    #[doc(alias = "webkit_policy_decision_download")]
    fn download(&self);

    /// [`ResponsePolicyDecision`][crate::ResponsePolicyDecision], this would cancel the request.
    ///
    /// Ignore the action which triggered this decision. For instance, for a
    /// [`ResponsePolicyDecision`][crate::ResponsePolicyDecision], this would cancel the request.
    #[doc(alias = "webkit_policy_decision_ignore")]
    fn ignore(&self);

    #[doc(alias = "webkit_policy_decision_use")]
    #[doc(alias = "use")]
    fn use_(&self);

    /// Accept the navigation action and continue with provided `policies`.
    ///
    /// Accept the navigation action which triggered this decision, and
    /// continue with `policies` affecting all subsequent loads of resources
    /// in the origin associated with the accepted navigation action.
    ///
    /// For example, a navigation decision to a video sharing website may
    /// be accepted under the priviso no movies are allowed to autoplay. The
    /// autoplay policy in this case would be set in the `policies`.
    /// ## `policies`
    /// a [`WebsitePolicies`][crate::WebsitePolicies]
    #[cfg(any(feature = "v2_30", feature = "dox"))]
    #[cfg_attr(feature = "dox", doc(cfg(feature = "v2_30")))]
    #[doc(alias = "webkit_policy_decision_use_with_policies")]
    fn use_with_policies(&self, policies: &impl IsA<WebsitePolicies>);
}

impl<O: IsA<PolicyDecision>> PolicyDecisionExt for O {
    fn download(&self) {
        unsafe {
            ffi::webkit_policy_decision_download(self.as_ref().to_glib_none().0);
        }
    }

    fn ignore(&self) {
        unsafe {
            ffi::webkit_policy_decision_ignore(self.as_ref().to_glib_none().0);
        }
    }

    fn use_(&self) {
        unsafe {
            ffi::webkit_policy_decision_use(self.as_ref().to_glib_none().0);
        }
    }

    #[cfg(any(feature = "v2_30", feature = "dox"))]
    #[cfg_attr(feature = "dox", doc(cfg(feature = "v2_30")))]
    fn use_with_policies(&self, policies: &impl IsA<WebsitePolicies>) {
        unsafe {
            ffi::webkit_policy_decision_use_with_policies(
                self.as_ref().to_glib_none().0,
                policies.as_ref().to_glib_none().0,
            );
        }
    }
}

impl fmt::Display for PolicyDecision {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.write_str("PolicyDecision")
    }
}