Skip to main content

rustenium_cdp_definitions/browser_protocol/overlay/
events.rs

1use serde::{Deserialize, Serialize};
2#[doc = "Fired when the node should be inspected. This happens after call to `setInspectMode` or when\nuser manually inspects an element.\n[inspectNodeRequested](https://chromedevtools.github.io/devtools-protocol/tot/Overlay/#event-inspectNodeRequested)"]
3#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
4pub struct InspectNodeRequestedParams {
5    #[doc = "Id of the node to inspect."]
6    #[serde(rename = "backendNodeId")]
7    pub backend_node_id: crate::browser_protocol::dom::types::BackendNodeId,
8}
9#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
10pub enum InspectNodeRequestedMethod {
11    #[serde(rename = "Overlay.inspectNodeRequested")]
12    InspectNodeRequested,
13}
14#[doc = "Fired when the node should be inspected. This happens after call to `setInspectMode` or when\nuser manually inspects an element.\n[inspectNodeRequested](https://chromedevtools.github.io/devtools-protocol/tot/Overlay/#event-inspectNodeRequested)"]
15#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
16pub struct InspectNodeRequested {
17    pub method: InspectNodeRequestedMethod,
18    pub params: InspectNodeRequestedParams,
19}
20impl InspectNodeRequested {
21    pub const IDENTIFIER: &'static str = "Overlay.inspectNodeRequested";
22    pub fn identifier(&self) -> &'static str {
23        Self::IDENTIFIER
24    }
25}
26#[doc = "Fired when the node should be highlighted. This happens after call to `setInspectMode`.\n[nodeHighlightRequested](https://chromedevtools.github.io/devtools-protocol/tot/Overlay/#event-nodeHighlightRequested)"]
27#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
28pub struct NodeHighlightRequestedParams {
29    #[serde(rename = "nodeId")]
30    pub node_id: crate::browser_protocol::dom::types::NodeId,
31}
32#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
33pub enum NodeHighlightRequestedMethod {
34    #[serde(rename = "Overlay.nodeHighlightRequested")]
35    NodeHighlightRequested,
36}
37#[doc = "Fired when the node should be highlighted. This happens after call to `setInspectMode`.\n[nodeHighlightRequested](https://chromedevtools.github.io/devtools-protocol/tot/Overlay/#event-nodeHighlightRequested)"]
38#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
39pub struct NodeHighlightRequested {
40    pub method: NodeHighlightRequestedMethod,
41    pub params: NodeHighlightRequestedParams,
42}
43impl NodeHighlightRequested {
44    pub const IDENTIFIER: &'static str = "Overlay.nodeHighlightRequested";
45    pub fn identifier(&self) -> &'static str {
46        Self::IDENTIFIER
47    }
48}
49#[doc = "Fired when user asks to capture screenshot of some area on the page.\n[screenshotRequested](https://chromedevtools.github.io/devtools-protocol/tot/Overlay/#event-screenshotRequested)"]
50#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
51pub struct ScreenshotRequestedParams {
52    #[doc = "Viewport to capture, in device independent pixels (dip)."]
53    #[serde(rename = "viewport")]
54    pub viewport: crate::browser_protocol::page::types::Viewport,
55}
56#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
57pub enum ScreenshotRequestedMethod {
58    #[serde(rename = "Overlay.screenshotRequested")]
59    ScreenshotRequested,
60}
61#[doc = "Fired when user asks to capture screenshot of some area on the page.\n[screenshotRequested](https://chromedevtools.github.io/devtools-protocol/tot/Overlay/#event-screenshotRequested)"]
62#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
63pub struct ScreenshotRequested {
64    pub method: ScreenshotRequestedMethod,
65    pub params: ScreenshotRequestedParams,
66}
67impl ScreenshotRequested {
68    pub const IDENTIFIER: &'static str = "Overlay.screenshotRequested";
69    pub fn identifier(&self) -> &'static str {
70        Self::IDENTIFIER
71    }
72}
73#[doc = "Fired when user asks to show the Inspect panel.\n[inspectPanelShowRequested](https://chromedevtools.github.io/devtools-protocol/tot/Overlay/#event-inspectPanelShowRequested)"]
74#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
75pub struct InspectPanelShowRequestedParams {
76    #[doc = "Id of the node to show in the panel."]
77    #[serde(rename = "backendNodeId")]
78    pub backend_node_id: crate::browser_protocol::dom::types::BackendNodeId,
79}
80#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
81pub enum InspectPanelShowRequestedMethod {
82    #[serde(rename = "Overlay.inspectPanelShowRequested")]
83    InspectPanelShowRequested,
84}
85#[doc = "Fired when user asks to show the Inspect panel.\n[inspectPanelShowRequested](https://chromedevtools.github.io/devtools-protocol/tot/Overlay/#event-inspectPanelShowRequested)"]
86#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
87pub struct InspectPanelShowRequested {
88    pub method: InspectPanelShowRequestedMethod,
89    pub params: InspectPanelShowRequestedParams,
90}
91impl InspectPanelShowRequested {
92    pub const IDENTIFIER: &'static str = "Overlay.inspectPanelShowRequested";
93    pub fn identifier(&self) -> &'static str {
94        Self::IDENTIFIER
95    }
96}
97#[doc = "Fired when user asks to restore the Inspected Element floating window.\n[inspectedElementWindowRestored](https://chromedevtools.github.io/devtools-protocol/tot/Overlay/#event-inspectedElementWindowRestored)"]
98#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
99pub struct InspectedElementWindowRestoredParams {
100    #[doc = "Id of the node to restore the floating window for."]
101    #[serde(rename = "backendNodeId")]
102    pub backend_node_id: crate::browser_protocol::dom::types::BackendNodeId,
103}
104#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
105pub enum InspectedElementWindowRestoredMethod {
106    #[serde(rename = "Overlay.inspectedElementWindowRestored")]
107    InspectedElementWindowRestored,
108}
109#[doc = "Fired when user asks to restore the Inspected Element floating window.\n[inspectedElementWindowRestored](https://chromedevtools.github.io/devtools-protocol/tot/Overlay/#event-inspectedElementWindowRestored)"]
110#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
111pub struct InspectedElementWindowRestored {
112    pub method: InspectedElementWindowRestoredMethod,
113    pub params: InspectedElementWindowRestoredParams,
114}
115impl InspectedElementWindowRestored {
116    pub const IDENTIFIER: &'static str = "Overlay.inspectedElementWindowRestored";
117    pub fn identifier(&self) -> &'static str {
118        Self::IDENTIFIER
119    }
120}
121#[doc = "Fired when user cancels the inspect mode.\n[inspectModeCanceled](https://chromedevtools.github.io/devtools-protocol/tot/Overlay/#event-inspectModeCanceled)"]
122#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
123pub struct InspectModeCanceledParams {}
124#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
125pub enum InspectModeCanceledMethod {
126    #[serde(rename = "Overlay.inspectModeCanceled")]
127    InspectModeCanceled,
128}
129#[doc = "Fired when user cancels the inspect mode.\n[inspectModeCanceled](https://chromedevtools.github.io/devtools-protocol/tot/Overlay/#event-inspectModeCanceled)"]
130#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
131pub struct InspectModeCanceled {
132    pub method: InspectModeCanceledMethod,
133    pub params: InspectModeCanceledParams,
134}
135impl InspectModeCanceled {
136    pub const IDENTIFIER: &'static str = "Overlay.inspectModeCanceled";
137    pub fn identifier(&self) -> &'static str {
138        Self::IDENTIFIER
139    }
140}
141group_enum ! (OverlayEvents { InspectNodeRequested (InspectNodeRequested) , NodeHighlightRequested (NodeHighlightRequested) , ScreenshotRequested (ScreenshotRequested) , InspectPanelShowRequested (InspectPanelShowRequested) , InspectedElementWindowRestored (InspectedElementWindowRestored) , InspectModeCanceled (InspectModeCanceled) } + identifiable);