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 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545
// // DO NOT EDIT. THIS FILE IS GENERATED FROM ../../../dist/idl/nsIImageLoadingContent.idl // /// `interface nsIImageLoadingContent : imgINotificationObserver` /// /// ```text /// /** /// * This interface represents a content node that loads images. The interface /// * exists to allow getting information on the images that the content node /// * loads and to allow registration of observers for the image loads. /// * /// * Implementors of this interface should handle all the mechanics of actually /// * loading an image -- getting the URI, checking with content policies and /// * the security manager to see whether loading the URI is allowed, performing /// * the load, firing any DOM events as needed. /// * /// * An implementation of this interface may support the concepts of a /// * "current" image and a "pending" image. If it does, a request to change /// * the currently loaded image will start a "pending" request which will /// * become current only when the image is loaded. It is the responsibility of /// * observers to check which request they are getting notifications for. /// * /// * Please make sure to update the MozImageLoadingContent WebIDL /// * interface to mirror this interface when changing it. /// */ /// ``` /// // 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 nsIImageLoadingContent { vtable: *const nsIImageLoadingContentVTable, /// 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 nsIImageLoadingContent. unsafe impl XpCom for nsIImageLoadingContent { const IID: nsIID = nsID(0x0357123d, 0x9224, 0x4d12, [0xa4, 0x7e, 0x86, 0x8c, 0x32, 0x68, 0x97, 0x77]); } // 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 nsIImageLoadingContent { #[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 nsIImageLoadingContent. // 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 nsIImageLoadingContentCoerce { /// Cheaply cast a value of this type from a `nsIImageLoadingContent`. fn coerce_from(v: &nsIImageLoadingContent) -> &Self; } // The trivial implementation: We can obviously coerce ourselves to ourselves. impl nsIImageLoadingContentCoerce for nsIImageLoadingContent { #[inline] fn coerce_from(v: &nsIImageLoadingContent) -> &Self { v } } impl nsIImageLoadingContent { /// Cast this `nsIImageLoadingContent` to one of its base interfaces. #[inline] pub fn coerce<T: nsIImageLoadingContentCoerce>(&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 nsIImageLoadingContent { type Target = imgINotificationObserver; #[inline] fn deref(&self) -> &imgINotificationObserver { 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: imgINotificationObserverCoerce> nsIImageLoadingContentCoerce for T { #[inline] fn coerce_from(v: &nsIImageLoadingContent) -> &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 nsIImageLoadingContent // 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 nsIImageLoadingContentVTable { /// We need to include the members from the base interface's vtable at the start /// of the VTable definition. pub __base: imgINotificationObserverVTable, /* attribute boolean loadingEnabled; */ pub GetLoadingEnabled: unsafe extern "system" fn (this: *const nsIImageLoadingContent, aLoadingEnabled: *mut bool) -> nsresult, /* attribute boolean loadingEnabled; */ pub SetLoadingEnabled: unsafe extern "system" fn (this: *const nsIImageLoadingContent, aLoadingEnabled: bool) -> nsresult, /* readonly attribute short imageBlockingStatus; */ pub GetImageBlockingStatus: unsafe extern "system" fn (this: *const nsIImageLoadingContent, aImageBlockingStatus: *mut libc::int16_t) -> nsresult, /* [notxpcom] nsresult addNativeObserver (in imgINotificationObserver aObserver); */ pub AddNativeObserver: unsafe extern "system" fn (this: *const nsIImageLoadingContent, aObserver: *const imgINotificationObserver) -> nsresult, /* [notxpcom] nsresult removeNativeObserver (in imgINotificationObserver aObserver); */ pub RemoveNativeObserver: unsafe extern "system" fn (this: *const nsIImageLoadingContent, aObserver: *const imgINotificationObserver) -> nsresult, /* void addObserver (in imgINotificationObserver aObserver); */ pub AddObserver: unsafe extern "system" fn (this: *const nsIImageLoadingContent, aObserver: *const imgINotificationObserver) -> nsresult, /* void removeObserver (in imgINotificationObserver aObserver); */ pub RemoveObserver: unsafe extern "system" fn (this: *const nsIImageLoadingContent, aObserver: *const imgINotificationObserver) -> nsresult, /* imgIRequest getRequest (in long aRequestType); */ pub GetRequest: unsafe extern "system" fn (this: *const nsIImageLoadingContent, aRequestType: libc::int32_t, _retval: *mut *const imgIRequest) -> nsresult, /* void setBlockedRequest (in int16_t aContentDecision); */ pub SetBlockedRequest: unsafe extern "system" fn (this: *const nsIImageLoadingContent, aContentDecision: int16_t) -> nsresult, /* [noscript,notxpcom] boolean currentRequestHasSize (); */ pub CurrentRequestHasSize: unsafe extern "system" fn (this: *const nsIImageLoadingContent) -> bool, /* [notxpcom] void frameCreated (in nsIFrame aFrame); */ /// Unable to generate binding because `forward declaration nsIFrame is unsupported` pub FrameCreated: *const ::libc::c_void, /* [notxpcom] void frameDestroyed (in nsIFrame aFrame); */ /// Unable to generate binding because `forward declaration nsIFrame is unsupported` pub FrameDestroyed: *const ::libc::c_void, /* long getRequestType (in imgIRequest aRequest); */ pub GetRequestType: unsafe extern "system" fn (this: *const nsIImageLoadingContent, aRequest: *const imgIRequest, _retval: *mut libc::int32_t) -> nsresult, /* readonly attribute nsIURI currentURI; */ pub GetCurrentURI: unsafe extern "system" fn (this: *const nsIImageLoadingContent, aCurrentURI: *mut *const nsIURI) -> nsresult, /* nsIStreamListener loadImageWithChannel (in nsIChannel aChannel); */ pub LoadImageWithChannel: unsafe extern "system" fn (this: *const nsIImageLoadingContent, aChannel: *const nsIChannel, _retval: *mut *const nsIStreamListener) -> nsresult, /* [optional_argc] void forceReload ([optional] in boolean aNotify); */ /// Unable to generate binding because `optional_argc is unsupported` pub ForceReload: *const ::libc::c_void, /* void forceImageState (in boolean aForce, in unsigned long long aState); */ pub ForceImageState: unsafe extern "system" fn (this: *const nsIImageLoadingContent, aForce: bool, aState: libc::uint64_t) -> nsresult, /* readonly attribute unsigned long naturalWidth; */ pub GetNaturalWidth: unsafe extern "system" fn (this: *const nsIImageLoadingContent, aNaturalWidth: *mut libc::uint32_t) -> nsresult, /* readonly attribute unsigned long naturalHeight; */ pub GetNaturalHeight: unsafe extern "system" fn (this: *const nsIImageLoadingContent, aNaturalHeight: *mut libc::uint32_t) -> nsresult, /* [noscript,notxpcom] void onVisibilityChange (in Visibility aNewVisibility, in MaybeOnNonvisible aNonvisibleAction); */ /// Unable to generate binding because `native type mozilla::Visibility is unsupported` pub OnVisibilityChange: *const ::libc::c_void, } // The implementations of the function wrappers which are exposed to rust code. // Call these methods rather than manually calling through the VTable struct. impl nsIImageLoadingContent { /// ```text /// /** /// * Request types. Image loading content nodes attempt to do atomic /// * image changes when the image url is changed. This means that /// * when the url changes the new image load will start, but the old /// * image will remain the "current" request until the new image is /// * fully loaded. At that point, the old "current" request will be /// * discarded and the "pending" request will become "current". /// */ /// ``` /// pub const UNKNOWN_REQUEST: i64 = -1; pub const CURRENT_REQUEST: i64 = 0; pub const PENDING_REQUEST: i64 = 1; /// ```text /// /** /// * loadingEnabled is used to enable and disable loading in /// * situations where loading images is unwanted. Note that enabling /// * loading will *not* automatically trigger an image load. /// */ /// ``` /// /// `attribute boolean loadingEnabled;` #[inline] pub unsafe fn GetLoadingEnabled(&self, aLoadingEnabled: *mut bool) -> nsresult { ((*self.vtable).GetLoadingEnabled)(self, aLoadingEnabled) } /// ```text /// /** /// * loadingEnabled is used to enable and disable loading in /// * situations where loading images is unwanted. Note that enabling /// * loading will *not* automatically trigger an image load. /// */ /// ``` /// /// `attribute boolean loadingEnabled;` #[inline] pub unsafe fn SetLoadingEnabled(&self, aLoadingEnabled: bool) -> nsresult { ((*self.vtable).SetLoadingEnabled)(self, aLoadingEnabled) } /// ```text /// /** /// * Returns the image blocking status (@see nsIContentPolicy). This /// * will always be an nsIContentPolicy REJECT_* status for cases when /// * the image was blocked. This status always refers to the /// * CURRENT_REQUEST load. /// */ /// ``` /// /// `readonly attribute short imageBlockingStatus;` #[inline] pub unsafe fn GetImageBlockingStatus(&self, aImageBlockingStatus: *mut libc::int16_t) -> nsresult { ((*self.vtable).GetImageBlockingStatus)(self, aImageBlockingStatus) } /// ```text /// /** /// * Used to register an image decoder observer. Typically, this will /// * be a proxy for a frame that wants to paint the image. /// * Notifications from ongoing image loads will be passed to all /// * registered observers. Notifications for all request types, /// * current and pending, will be passed through. /// * /// * @param aObserver the observer to register /// * /// * @throws NS_ERROR_OUT_OF_MEMORY /// */ /// ``` /// /// `[notxpcom] nsresult addNativeObserver (in imgINotificationObserver aObserver);` #[inline] pub unsafe fn AddNativeObserver(&self, aObserver: *const imgINotificationObserver) -> nsresult { ((*self.vtable).AddNativeObserver)(self, aObserver) } /// ```text /// /** /// * Used to unregister an image decoder observer. /// * /// * @param aObserver the observer to unregister /// */ /// ``` /// /// `[notxpcom] nsresult removeNativeObserver (in imgINotificationObserver aObserver);` #[inline] pub unsafe fn RemoveNativeObserver(&self, aObserver: *const imgINotificationObserver) -> nsresult { ((*self.vtable).RemoveNativeObserver)(self, aObserver) } /// ```text /// /** /// * Same as addNativeObserver but intended for scripted observers or observers /// * from another or without a document. /// */ /// ``` /// /// `void addObserver (in imgINotificationObserver aObserver);` #[inline] pub unsafe fn AddObserver(&self, aObserver: *const imgINotificationObserver) -> nsresult { ((*self.vtable).AddObserver)(self, aObserver) } /// ```text /// /** /// * Same as removeNativeObserver but intended for scripted observers or /// * observers from another or without a document. /// */ /// ``` /// /// `void removeObserver (in imgINotificationObserver aObserver);` #[inline] pub unsafe fn RemoveObserver(&self, aObserver: *const imgINotificationObserver) -> nsresult { ((*self.vtable).RemoveObserver)(self, aObserver) } /// ```text /// /** /// * Accessor to get the image requests /// * /// * @param aRequestType a value saying which request is wanted /// * /// * @return the imgIRequest object (may be null, even when no error /// * is thrown) /// * /// * @throws NS_ERROR_UNEXPECTED if the request type requested is not /// * known /// */ /// ``` /// /// `imgIRequest getRequest (in long aRequestType);` #[inline] pub unsafe fn GetRequest(&self, aRequestType: libc::int32_t, _retval: *mut *const imgIRequest) -> nsresult { ((*self.vtable).GetRequest)(self, aRequestType, _retval) } /// ```text /// /** /// * Call this function when the request was blocked by any of the /// * security policies enforced. /// * /// * @param aContentDecision the decision returned from nsIContentPolicy /// * (any of the types REJECT_*) /// */ /// ``` /// /// `void setBlockedRequest (in int16_t aContentDecision);` #[inline] pub unsafe fn SetBlockedRequest(&self, aContentDecision: int16_t) -> nsresult { ((*self.vtable).SetBlockedRequest)(self, aContentDecision) } /// ```text /// /** /// * @return true if the current request's size is available. /// */ /// ``` /// /// `[noscript,notxpcom] boolean currentRequestHasSize ();` #[inline] pub unsafe fn CurrentRequestHasSize(&self, ) -> bool { ((*self.vtable).CurrentRequestHasSize)(self, ) } /// ```text /// /** /// * Used to notify the image loading content node that a frame has been /// * created. /// */ /// ``` /// /// `[notxpcom] void frameCreated (in nsIFrame aFrame);` const _FrameCreated: () = (); /// ```text /// /** /// * Used to notify the image loading content node that a frame has been /// * destroyed. /// */ /// ``` /// /// `[notxpcom] void frameDestroyed (in nsIFrame aFrame);` const _FrameDestroyed: () = (); /// ```text /// /** /// * Used to find out what type of request one is dealing with (eg /// * which request got passed through to the imgINotificationObserver /// * interface of an observer) /// * /// * @param aRequest the request whose type we want to know /// * /// * @return an enum value saying what type this request is /// * /// * @throws NS_ERROR_UNEXPECTED if aRequest is not known /// */ /// ``` /// /// `long getRequestType (in imgIRequest aRequest);` #[inline] pub unsafe fn GetRequestType(&self, aRequest: *const imgIRequest, _retval: *mut libc::int32_t) -> nsresult { ((*self.vtable).GetRequestType)(self, aRequest, _retval) } /// ```text /// /** /// * Gets the URI of the current request, if available. /// * Otherwise, returns the last URI that this content tried to load, or /// * null if there haven't been any such attempts. /// */ /// ``` /// /// `readonly attribute nsIURI currentURI;` #[inline] pub unsafe fn GetCurrentURI(&self, aCurrentURI: *mut *const nsIURI) -> nsresult { ((*self.vtable).GetCurrentURI)(self, aCurrentURI) } /// ```text /// /** /// * loadImageWithChannel allows data from an existing channel to be /// * used as the image data for this content node. /// * /// * @param aChannel the channel that will deliver the data /// * /// * @return a stream listener to pump the image data into /// * /// * @see imgILoader::loadImageWithChannel /// * /// * @throws NS_ERROR_NULL_POINTER if aChannel is null /// */ /// ``` /// /// `nsIStreamListener loadImageWithChannel (in nsIChannel aChannel);` #[inline] pub unsafe fn LoadImageWithChannel(&self, aChannel: *const nsIChannel, _retval: *mut *const nsIStreamListener) -> nsresult { ((*self.vtable).LoadImageWithChannel)(self, aChannel, _retval) } /// ```text /// /** /// * forceReload forces reloading of the image pointed to by currentURI /// * /// * @param aNotify [optional] request should notify, defaults to true /// * @throws NS_ERROR_NOT_AVAILABLE if there is no current URI to reload /// */ /// ``` /// /// `[optional_argc] void forceReload ([optional] in boolean aNotify);` const _ForceReload: () = (); /// ```text /// /** /// * Enables/disables image state forcing. When |aForce| is PR_TRUE, we force /// * nsImageLoadingContent::ImageState() to return |aState|. Call again with |aForce| /// * as PR_FALSE to revert ImageState() to its original behaviour. /// */ /// ``` /// /// `void forceImageState (in boolean aForce, in unsigned long long aState);` #[inline] pub unsafe fn ForceImageState(&self, aForce: bool, aState: libc::uint64_t) -> nsresult { ((*self.vtable).ForceImageState)(self, aForce, aState) } /// ```text /// /** /// * The intrinsic size and width of this content. May differ from actual image /// * size due to things like responsive image density. /// */ /// ``` /// /// `readonly attribute unsigned long naturalWidth;` #[inline] pub unsafe fn GetNaturalWidth(&self, aNaturalWidth: *mut libc::uint32_t) -> nsresult { ((*self.vtable).GetNaturalWidth)(self, aNaturalWidth) } /// `readonly attribute unsigned long naturalHeight;` #[inline] pub unsafe fn GetNaturalHeight(&self, aNaturalHeight: *mut libc::uint32_t) -> nsresult { ((*self.vtable).GetNaturalHeight)(self, aNaturalHeight) } /// ```text /// /** /// * Called by layout to announce when the frame associated with this content /// * has changed its visibility state. /// * /// * @param aNewVisibility The new visibility state. /// * @param aNonvisibleAction A requested action if the frame has become /// * nonvisible. If Nothing(), no action is /// * requested. If DISCARD_IMAGES is specified, the /// * frame is requested to ask any images it's /// * associated with to discard their surfaces if /// * possible. /// */ /// ``` /// /// `[noscript,notxpcom] void onVisibilityChange (in Visibility aNewVisibility, in MaybeOnNonvisible aNonvisibleAction);` const _OnVisibilityChange: () = (); }