Source code
Revision control
Copy as Markdown
Other Tools
//! This file has been automatically generated by `objc2`'s `header-translator`.
//! DO NOT EDIT
use core::ffi::*;
use core::ptr::NonNull;
use objc2::__framework_prelude::*;
use crate::*;
extern_class!(
/// Defines the order, repetition, and allowable values for a document
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/foundation/nsxmldtd?language=objc)
#[unsafe(super(NSXMLNode, NSObject))]
#[derive(Debug, PartialEq, Eq, Hash)]
#[cfg(feature = "NSXMLNode")]
pub struct NSXMLDTD;
);
#[cfg(all(feature = "NSObject", feature = "NSXMLNode"))]
extern_conformance!(
unsafe impl NSCopying for NSXMLDTD {}
);
#[cfg(all(feature = "NSObject", feature = "NSXMLNode"))]
unsafe impl CopyingHelper for NSXMLDTD {
type Result = Self;
}
#[cfg(feature = "NSXMLNode")]
extern_conformance!(
unsafe impl NSObjectProtocol for NSXMLDTD {}
);
#[cfg(feature = "NSXMLNode")]
impl NSXMLDTD {
extern_methods!(
#[unsafe(method(init))]
#[unsafe(method_family = init)]
pub fn init(this: Allocated<Self>) -> Retained<Self>;
#[cfg(feature = "NSXMLNodeOptions")]
#[unsafe(method(initWithKind:options:))]
#[unsafe(method_family = init)]
pub fn initWithKind_options(
this: Allocated<Self>,
kind: NSXMLNodeKind,
options: NSXMLNodeOptions,
) -> Retained<Self>;
#[cfg(all(feature = "NSError", feature = "NSURL", feature = "NSXMLNodeOptions"))]
#[unsafe(method(initWithContentsOfURL:options:error:_))]
#[unsafe(method_family = init)]
pub fn initWithContentsOfURL_options_error(
this: Allocated<Self>,
url: &NSURL,
mask: NSXMLNodeOptions,
) -> Result<Retained<Self>, Retained<NSError>>;
#[cfg(all(feature = "NSData", feature = "NSError", feature = "NSXMLNodeOptions"))]
#[unsafe(method(initWithData:options:error:_))]
#[unsafe(method_family = init)]
pub fn initWithData_options_error(
this: Allocated<Self>,
data: &NSData,
mask: NSXMLNodeOptions,
) -> Result<Retained<Self>, Retained<NSError>>;
#[cfg(feature = "NSString")]
/// Sets the public id. This identifier should be in the default catalog in /etc/xml/catalog or in a path specified by the environment variable XML_CATALOG_FILES. When the public id is set the system id must also be set.
#[unsafe(method(publicID))]
#[unsafe(method_family = none)]
pub fn publicID(&self) -> Option<Retained<NSString>>;
#[cfg(feature = "NSString")]
/// Setter for [`publicID`][Self::publicID].
///
/// This is [copied][crate::NSCopying::copy] when set.
#[unsafe(method(setPublicID:))]
#[unsafe(method_family = none)]
pub fn setPublicID(&self, public_id: Option<&NSString>);
#[cfg(feature = "NSString")]
/// Sets the system id. This should be a URL that points to a valid DTD.
#[unsafe(method(systemID))]
#[unsafe(method_family = none)]
pub fn systemID(&self) -> Option<Retained<NSString>>;
#[cfg(feature = "NSString")]
/// Setter for [`systemID`][Self::systemID].
///
/// This is [copied][crate::NSCopying::copy] when set.
#[unsafe(method(setSystemID:))]
#[unsafe(method_family = none)]
pub fn setSystemID(&self, system_id: Option<&NSString>);
/// Inserts a child at a particular index.
#[unsafe(method(insertChild:atIndex:))]
#[unsafe(method_family = none)]
pub fn insertChild_atIndex(&self, child: &NSXMLNode, index: NSUInteger);
#[cfg(feature = "NSArray")]
/// Insert several children at a particular index.
#[unsafe(method(insertChildren:atIndex:))]
#[unsafe(method_family = none)]
pub fn insertChildren_atIndex(&self, children: &NSArray<NSXMLNode>, index: NSUInteger);
/// Removes a child at a particular index.
#[unsafe(method(removeChildAtIndex:))]
#[unsafe(method_family = none)]
pub fn removeChildAtIndex(&self, index: NSUInteger);
#[cfg(feature = "NSArray")]
/// Removes all existing children and replaces them with the new children. Set children to nil to simply remove all children.
#[unsafe(method(setChildren:))]
#[unsafe(method_family = none)]
pub fn setChildren(&self, children: Option<&NSArray<NSXMLNode>>);
/// Adds a child to the end of the existing children.
#[unsafe(method(addChild:))]
#[unsafe(method_family = none)]
pub fn addChild(&self, child: &NSXMLNode);
/// Replaces a child at a particular index with another child.
#[unsafe(method(replaceChildAtIndex:withNode:))]
#[unsafe(method_family = none)]
pub fn replaceChildAtIndex_withNode(&self, index: NSUInteger, node: &NSXMLNode);
#[cfg(all(feature = "NSString", feature = "NSXMLDTDNode"))]
/// Returns the entity declaration matching this name.
#[unsafe(method(entityDeclarationForName:))]
#[unsafe(method_family = none)]
pub fn entityDeclarationForName(&self, name: &NSString) -> Option<Retained<NSXMLDTDNode>>;
#[cfg(all(feature = "NSString", feature = "NSXMLDTDNode"))]
/// Returns the notation declaration matching this name.
#[unsafe(method(notationDeclarationForName:))]
#[unsafe(method_family = none)]
pub fn notationDeclarationForName(&self, name: &NSString)
-> Option<Retained<NSXMLDTDNode>>;
#[cfg(all(feature = "NSString", feature = "NSXMLDTDNode"))]
/// Returns the element declaration matching this name.
#[unsafe(method(elementDeclarationForName:))]
#[unsafe(method_family = none)]
pub fn elementDeclarationForName(&self, name: &NSString) -> Option<Retained<NSXMLDTDNode>>;
#[cfg(all(feature = "NSString", feature = "NSXMLDTDNode"))]
/// Returns the attribute declaration matching this name.
#[unsafe(method(attributeDeclarationForName:elementName:))]
#[unsafe(method_family = none)]
pub fn attributeDeclarationForName_elementName(
&self,
name: &NSString,
element_name: &NSString,
) -> Option<Retained<NSXMLDTDNode>>;
#[cfg(all(feature = "NSString", feature = "NSXMLDTDNode"))]
/// Returns the predefined entity declaration matching this name.
///
/// The five predefined entities are
/// <ul>
/// <li>
/// &
/// lt; -
/// <
/// </li>
/// <li>
/// &
/// gt; -
/// >
/// </li>
/// <li>
/// &
/// amp; -
/// &
/// </li>
/// <li>
/// &
/// quot; -
/// "
/// </li>
/// <li>
/// &
/// apos; -
/// &
/// </li>
/// </ul>
#[unsafe(method(predefinedEntityDeclarationForName:))]
#[unsafe(method_family = none)]
pub fn predefinedEntityDeclarationForName(
name: &NSString,
) -> Option<Retained<NSXMLDTDNode>>;
);
}
/// Methods declared on superclass `NSXMLNode`.
#[cfg(feature = "NSXMLNode")]
impl NSXMLDTD {
extern_methods!(
/// Invokes
///
/// ```text
/// initWithKind:options:
/// ```
///
/// with options set to NSXMLNodeOptionsNone
#[unsafe(method(initWithKind:))]
#[unsafe(method_family = init)]
pub fn initWithKind(this: Allocated<Self>, kind: NSXMLNodeKind) -> Retained<Self>;
);
}
/// Methods declared on superclass `NSObject`.
#[cfg(feature = "NSXMLNode")]
impl NSXMLDTD {
extern_methods!(
#[unsafe(method(new))]
#[unsafe(method_family = new)]
pub fn new() -> Retained<Self>;
);
}
#[cfg(feature = "NSXMLNode")]
impl DefaultRetained for NSXMLDTD {
#[inline]
fn default_retained() -> Retained<Self> {
Self::new()
}
}