atspi_common/events/
document.rs

1use crate::events::{DBusInterface, DBusMatchRule, DBusMember, RegistryEventString};
2use crate::object_ref::ObjectRefOwned;
3#[cfg(feature = "zbus")]
4use crate::EventProperties;
5
6#[cfg(feature = "zbus")]
7use crate::AtspiError;
8#[cfg(feature = "zbus")]
9use zbus::message::Header;
10
11/// An event triggered by the completion of a document load action.
12/// For example: a web page has finished loading its initial payload, or
13/// `LibreOffice` has loaded a document from disk.
14#[derive(Debug, PartialEq, Clone, serde::Serialize, serde::Deserialize, Eq, Hash, Default)]
15pub struct LoadCompleteEvent {
16	/// The [`crate::ObjectRef`] which the event applies to.
17	pub item: ObjectRefOwned,
18}
19
20/// An event triggered by a reloading of a document.
21/// For example: pressing F5, or `Control + r` will reload a page in a web browser.
22#[derive(Debug, PartialEq, Clone, serde::Serialize, serde::Deserialize, Eq, Hash, Default)]
23pub struct ReloadEvent {
24	/// The [`crate::ObjectRef`] which the event applies to.
25	pub item: ObjectRefOwned,
26}
27
28/// An event triggered by the cancelling of a document load.
29/// For example: during the loading of a large web page, a user may press `Escape` to stop loading the page.
30#[derive(Debug, PartialEq, Clone, serde::Serialize, serde::Deserialize, Eq, Hash, Default)]
31pub struct LoadStoppedEvent {
32	/// The [`crate::ObjectRef`] which the event applies to.
33	pub item: ObjectRefOwned,
34}
35
36#[derive(Debug, PartialEq, Clone, serde::Serialize, serde::Deserialize, Eq, Hash, Default)]
37pub struct ContentChangedEvent {
38	/// The [`crate::ObjectRef`] which the event applies to.
39	pub item: ObjectRefOwned,
40}
41
42#[derive(Debug, PartialEq, Clone, serde::Serialize, serde::Deserialize, Eq, Hash, Default)]
43pub struct AttributesChangedEvent {
44	/// The [`crate::ObjectRef`] which the event applies to.
45	pub item: ObjectRefOwned,
46}
47
48/// The focused page has changed.
49///
50/// This event is usually sent only by document readers, signaling
51/// that the _physical page equivalent is now different.
52/// This event does not encode _which_ page is the new one, only that a new page is now the primary
53/// one.
54///
55/// See `atspi_proxies::document::DocumentProxy::current_page_number` to actively find the
56/// page number.
57#[derive(Debug, PartialEq, Clone, serde::Serialize, serde::Deserialize, Eq, Hash, Default)]
58pub struct PageChangedEvent {
59	/// The [`crate::ObjectRef`] which the event applies to.
60	pub item: ObjectRefOwned,
61}
62
63impl_member_interface_registry_string_and_match_rule_for_event!(
64	LoadCompleteEvent,
65	"LoadComplete",
66	"org.a11y.atspi.Event.Document",
67	"document:load-complete",
68	"type='signal',interface='org.a11y.atspi.Event.Document',member='LoadComplete'"
69);
70
71impl_member_interface_registry_string_and_match_rule_for_event!(
72	ReloadEvent,
73	"Reload",
74	"org.a11y.atspi.Event.Document",
75	"document:reload",
76	"type='signal',interface='org.a11y.atspi.Event.Document',member='LoadStopped'"
77);
78
79impl_member_interface_registry_string_and_match_rule_for_event!(
80	LoadStoppedEvent,
81	"LoadStopped",
82	"org.a11y.atspi.Event.Document",
83	"document:load-stopped",
84	"type='signal',interface='org.a11y.atspi.Event.Document',member='LoadStopped'"
85);
86
87// TODO confirm registry event string, not found in grep at at-spi2-core
88impl_member_interface_registry_string_and_match_rule_for_event!(
89	ContentChangedEvent,
90	"ContentChanged",
91	"org.a11y.atspi.Event.Document",
92	"document:content-changed",
93	"type='signal',interface='org.a11y.atspi.Event.Document',member='ContentChanged'"
94);
95
96impl_member_interface_registry_string_and_match_rule_for_event!(
97	AttributesChangedEvent,
98	"AttributesChanged",
99	"org.a11y.atspi.Event.Document",
100	"document:attributes-changed",
101	"type='signal',interface='org.a11y.atspi.Event.Document',member='AttributesChanged'"
102);
103
104impl_member_interface_registry_string_and_match_rule_for_event!(
105	PageChangedEvent,
106	"PageChanged",
107	"org.a11y.atspi.Event.Document",
108	"document:page-changed",
109	"type='signal',interface='org.a11y.atspi.Event.Document',member='PageChanged'"
110);
111
112impl_event_type_properties_for_event!(LoadCompleteEvent);
113
114event_test_cases!(LoadCompleteEvent);
115impl_to_dbus_message!(LoadCompleteEvent);
116impl_from_dbus_message!(LoadCompleteEvent);
117impl_event_properties!(LoadCompleteEvent);
118impl_from_object_ref!(LoadCompleteEvent);
119
120impl_event_type_properties_for_event!(ReloadEvent);
121event_test_cases!(ReloadEvent);
122impl_to_dbus_message!(ReloadEvent);
123impl_from_dbus_message!(ReloadEvent);
124impl_event_properties!(ReloadEvent);
125impl_from_object_ref!(ReloadEvent);
126
127impl_event_type_properties_for_event!(LoadStoppedEvent);
128event_test_cases!(LoadStoppedEvent);
129impl_to_dbus_message!(LoadStoppedEvent);
130impl_from_dbus_message!(LoadStoppedEvent);
131impl_event_properties!(LoadStoppedEvent);
132impl_from_object_ref!(LoadStoppedEvent);
133
134impl_event_type_properties_for_event!(ContentChangedEvent);
135event_test_cases!(ContentChangedEvent);
136impl_to_dbus_message!(ContentChangedEvent);
137impl_from_dbus_message!(ContentChangedEvent);
138impl_event_properties!(ContentChangedEvent);
139impl_from_object_ref!(ContentChangedEvent);
140
141impl_event_type_properties_for_event!(AttributesChangedEvent);
142event_test_cases!(AttributesChangedEvent);
143impl_to_dbus_message!(AttributesChangedEvent);
144impl_from_dbus_message!(AttributesChangedEvent);
145impl_event_properties!(AttributesChangedEvent);
146impl_from_object_ref!(AttributesChangedEvent);
147
148impl_event_type_properties_for_event!(PageChangedEvent);
149event_test_cases!(PageChangedEvent);
150impl_to_dbus_message!(PageChangedEvent);
151impl_from_dbus_message!(PageChangedEvent);
152impl_event_properties!(PageChangedEvent);
153impl_from_object_ref!(PageChangedEvent);
154impl_msg_conversion_ext_for_target_type!(LoadCompleteEvent);
155impl_msg_conversion_ext_for_target_type!(ReloadEvent);
156impl_msg_conversion_ext_for_target_type!(LoadStoppedEvent);
157impl_msg_conversion_ext_for_target_type!(ContentChangedEvent);
158impl_msg_conversion_ext_for_target_type!(AttributesChangedEvent);
159impl_msg_conversion_ext_for_target_type!(PageChangedEvent);
160
161impl_msg_conversion_for_types_built_from_object_ref!(LoadCompleteEvent);
162impl_msg_conversion_for_types_built_from_object_ref!(ReloadEvent);
163impl_msg_conversion_for_types_built_from_object_ref!(LoadStoppedEvent);
164impl_msg_conversion_for_types_built_from_object_ref!(ContentChangedEvent);
165impl_msg_conversion_for_types_built_from_object_ref!(AttributesChangedEvent);
166impl_msg_conversion_for_types_built_from_object_ref!(PageChangedEvent);
atspi_common/events/document.rs

atspi_common/events/
document.rs
