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 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
// // DO NOT EDIT. THIS FILE IS GENERATED FROM ../../../dist/idl/nsIWebBrowserFocus.idl // /// `interface nsIWebBrowserFocus : nsISupports` /// /// ```text /// /** /// * nsIWebBrowserFocus /// * Interface that embedders use for controlling and interacting /// * with the browser focus management. The embedded browser can be focused by /// * clicking in it or tabbing into it. If the browser is currently focused and /// * the embedding application's top level window is disabled, deactivate() must /// * be called, and activate() called again when the top level window is /// * reactivated for the browser's focus memory to work correctly. /// */ /// ``` /// // The actual type definition for the interface. This struct has methods // declared on it which will call through its vtable. You never want to pass // this type around by value, always pass it behind a reference. #[repr(C)] pub struct nsIWebBrowserFocus { vtable: *const nsIWebBrowserFocusVTable, /// This field is a phantomdata to ensure that the VTable type and any /// struct containing it is not safe to send across threads, as XPCOM is /// generally not threadsafe. /// /// XPCOM interfaces in general are not safe to send across threads. __nosync: ::std::marker::PhantomData<::std::rc::Rc<u8>>, } // Implementing XpCom for an interface exposes its IID, which allows for easy // use of the `.query_interface<T>` helper method. This also defines that // method for nsIWebBrowserFocus. unsafe impl XpCom for nsIWebBrowserFocus { const IID: nsIID = nsID(0x7f8c754e, 0x5b36, 0x44be, [0xbc, 0x96, 0x19, 0x1b, 0x49, 0xf0, 0x8e, 0xa6]); } // We need to implement the RefCounted trait so we can be used with `RefPtr`. // This trait teaches `RefPtr` how to manage our memory. unsafe impl RefCounted for nsIWebBrowserFocus { #[inline] unsafe fn addref(&self) { self.AddRef(); } #[inline] unsafe fn release(&self) { self.Release(); } } // This trait is implemented on all types which can be coerced to from nsIWebBrowserFocus. // It is used in the implementation of `fn coerce<T>`. We hide it from the // documentation, because it clutters it up a lot. #[doc(hidden)] pub trait nsIWebBrowserFocusCoerce { /// Cheaply cast a value of this type from a `nsIWebBrowserFocus`. fn coerce_from(v: &nsIWebBrowserFocus) -> &Self; } // The trivial implementation: We can obviously coerce ourselves to ourselves. impl nsIWebBrowserFocusCoerce for nsIWebBrowserFocus { #[inline] fn coerce_from(v: &nsIWebBrowserFocus) -> &Self { v } } impl nsIWebBrowserFocus { /// Cast this `nsIWebBrowserFocus` to one of its base interfaces. #[inline] pub fn coerce<T: nsIWebBrowserFocusCoerce>(&self) -> &T { T::coerce_from(self) } } // Every interface struct type implements `Deref` to its base interface. This // causes methods on the base interfaces to be directly avaliable on the // object. For example, you can call `.AddRef` or `.QueryInterface` directly // on any interface which inherits from `nsISupports`. impl ::std::ops::Deref for nsIWebBrowserFocus { type Target = nsISupports; #[inline] fn deref(&self) -> &nsISupports { unsafe { ::std::mem::transmute(self) } } } // Ensure we can use .coerce() to cast to our base types as well. Any type which // our base interface can coerce from should be coercable from us as well. impl<T: nsISupportsCoerce> nsIWebBrowserFocusCoerce for T { #[inline] fn coerce_from(v: &nsIWebBrowserFocus) -> &Self { T::coerce_from(v) } } // This struct represents the interface's VTable. A pointer to a statically // allocated version of this struct is at the beginning of every nsIWebBrowserFocus // object. It contains one pointer field for each method in the interface. In // the case where we can't generate a binding for a method, we include a void // pointer. #[doc(hidden)] #[repr(C)] pub struct nsIWebBrowserFocusVTable { /// We need to include the members from the base interface's vtable at the start /// of the VTable definition. pub __base: nsISupportsVTable, /* void activate (); */ pub Activate: unsafe extern "system" fn (this: *const nsIWebBrowserFocus) -> nsresult, /* void deactivate (); */ pub Deactivate: unsafe extern "system" fn (this: *const nsIWebBrowserFocus) -> nsresult, /* void setFocusAtFirstElement (); */ pub SetFocusAtFirstElement: unsafe extern "system" fn (this: *const nsIWebBrowserFocus) -> nsresult, /* void setFocusAtLastElement (); */ pub SetFocusAtLastElement: unsafe extern "system" fn (this: *const nsIWebBrowserFocus) -> nsresult, /* attribute mozIDOMWindowProxy focusedWindow; */ pub GetFocusedWindow: unsafe extern "system" fn (this: *const nsIWebBrowserFocus, aFocusedWindow: *mut *const mozIDOMWindowProxy) -> nsresult, /* attribute mozIDOMWindowProxy focusedWindow; */ pub SetFocusedWindow: unsafe extern "system" fn (this: *const nsIWebBrowserFocus, aFocusedWindow: *const mozIDOMWindowProxy) -> nsresult, /* attribute nsIDOMElement focusedElement; */ pub GetFocusedElement: unsafe extern "system" fn (this: *const nsIWebBrowserFocus, aFocusedElement: *mut *const nsIDOMElement) -> nsresult, /* attribute nsIDOMElement focusedElement; */ pub SetFocusedElement: unsafe extern "system" fn (this: *const nsIWebBrowserFocus, aFocusedElement: *const nsIDOMElement) -> nsresult, } // The implementations of the function wrappers which are exposed to rust code. // Call these methods rather than manually calling through the VTable struct. impl nsIWebBrowserFocus { /// ```text /// /** /// * MANDATORY /// * activate() is a mandatory call that must be made to the browser /// * when the embedding application's window is activated *and* the /// * browser area was the last thing in focus. This method can also be called /// * if the embedding application wishes to give the browser area focus, /// * without affecting the currently focused element within the browser. /// * /// * @note /// * If you fail to make this call, mozilla focus memory will not work /// * correctly. /// */ /// ``` /// /// `void activate ();` #[inline] pub unsafe fn Activate(&self, ) -> nsresult { ((*self.vtable).Activate)(self, ) } /// ```text /// /** /// * MANDATORY /// * deactivate() is a mandatory call that must be made to the browser /// * when the embedding application's window is deactivated *and* the /// * browser area was the last thing in focus. On non-windows platforms, /// * deactivate() should also be called when focus moves from the browser /// * to the embedding chrome. /// * /// * @note /// * If you fail to make this call, mozilla focus memory will not work /// * correctly. /// */ /// ``` /// /// `void deactivate ();` #[inline] pub unsafe fn Deactivate(&self, ) -> nsresult { ((*self.vtable).Deactivate)(self, ) } /// ```text /// /** /// * Give the first element focus within mozilla /// * (i.e. TAB was pressed and focus should enter mozilla) /// */ /// ``` /// /// `void setFocusAtFirstElement ();` #[inline] pub unsafe fn SetFocusAtFirstElement(&self, ) -> nsresult { ((*self.vtable).SetFocusAtFirstElement)(self, ) } /// ```text /// /** /// * Give the last element focus within mozilla /// * (i.e. SHIFT-TAB was pressed and focus should enter mozilla) /// */ /// ``` /// /// `void setFocusAtLastElement ();` #[inline] pub unsafe fn SetFocusAtLastElement(&self, ) -> nsresult { ((*self.vtable).SetFocusAtLastElement)(self, ) } /// ```text /// /** /// * The currently focused nsDOMWindow when the browser is active, /// * or the last focused nsDOMWindow when the browser is inactive. /// */ /// ``` /// /// `attribute mozIDOMWindowProxy focusedWindow;` #[inline] pub unsafe fn GetFocusedWindow(&self, aFocusedWindow: *mut *const mozIDOMWindowProxy) -> nsresult { ((*self.vtable).GetFocusedWindow)(self, aFocusedWindow) } /// ```text /// /** /// * The currently focused nsDOMWindow when the browser is active, /// * or the last focused nsDOMWindow when the browser is inactive. /// */ /// ``` /// /// `attribute mozIDOMWindowProxy focusedWindow;` #[inline] pub unsafe fn SetFocusedWindow(&self, aFocusedWindow: *const mozIDOMWindowProxy) -> nsresult { ((*self.vtable).SetFocusedWindow)(self, aFocusedWindow) } /// ```text /// /** /// * The currently focused nsDOMElement when the browser is active, /// * or the last focused nsDOMElement when the browser is inactive. /// */ /// ``` /// /// `attribute nsIDOMElement focusedElement;` #[inline] pub unsafe fn GetFocusedElement(&self, aFocusedElement: *mut *const nsIDOMElement) -> nsresult { ((*self.vtable).GetFocusedElement)(self, aFocusedElement) } /// ```text /// /** /// * The currently focused nsDOMElement when the browser is active, /// * or the last focused nsDOMElement when the browser is inactive. /// */ /// ``` /// /// `attribute nsIDOMElement focusedElement;` #[inline] pub unsafe fn SetFocusedElement(&self, aFocusedElement: *const nsIDOMElement) -> nsresult { ((*self.vtable).SetFocusedElement)(self, aFocusedElement) } }