Struct NSBezierPath

#[repr(C)]
pub struct NSBezierPath { /* private fields */ }

Available on crate feature NSBezierPath only.

Apple’s documentation

Implementations

impl NSBezierPath

pub unsafe fn bezierPath() -> Retained<NSBezierPath>

pub unsafe fn bezierPathWithRect(rect: NSRect) -> Retained<NSBezierPath>

pub unsafe fn bezierPathWithOvalInRect(rect: NSRect) -> Retained<NSBezierPath>

pub unsafe fn bezierPathWithRoundedRect_xRadius_yRadius( rect: NSRect, x_radius: CGFloat, y_radius: CGFloat, ) -> Retained<NSBezierPath>

Available on crate feature objc2-core-foundation only.

pub unsafe fn bezierPathWithCGPath(cg_path: &CGPath) -> Retained<NSBezierPath>

Available on crate feature objc2-core-graphics and Apple only.

pub unsafe fn CGPath(&self) -> Retained<CGPath>

Available on crate feature objc2-core-graphics and Apple only.

pub unsafe fn setCGPath(&self, cg_path: &CGPath)

Available on crate feature objc2-core-graphics and Apple only.

Setter for CGPath.

pub unsafe fn fillRect(rect: NSRect)

pub unsafe fn strokeRect(rect: NSRect)

pub unsafe fn clipRect(rect: NSRect)

pub unsafe fn strokeLineFromPoint_toPoint(point1: NSPoint, point2: NSPoint)

pub unsafe fn drawPackedGlyphs_atPoint( packed_glyphs: NonNull<c_char>, point: NSPoint, )

pub unsafe fn defaultMiterLimit() -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setDefaultMiterLimit(default_miter_limit: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for defaultMiterLimit.

pub unsafe fn defaultFlatness() -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setDefaultFlatness(default_flatness: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for defaultFlatness.

pub unsafe fn defaultWindingRule() -> NSWindingRule

pub unsafe fn setDefaultWindingRule(default_winding_rule: NSWindingRule)

Setter for defaultWindingRule.

pub unsafe fn defaultLineCapStyle() -> NSLineCapStyle

pub unsafe fn setDefaultLineCapStyle(default_line_cap_style: NSLineCapStyle)

Setter for defaultLineCapStyle.

pub unsafe fn defaultLineJoinStyle() -> NSLineJoinStyle

pub unsafe fn setDefaultLineJoinStyle(default_line_join_style: NSLineJoinStyle)

Setter for defaultLineJoinStyle.

pub unsafe fn defaultLineWidth() -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setDefaultLineWidth(default_line_width: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for defaultLineWidth.

pub unsafe fn moveToPoint(&self, point: NSPoint)

pub unsafe fn lineToPoint(&self, point: NSPoint)

pub unsafe fn curveToPoint_controlPoint1_controlPoint2( &self, end_point: NSPoint, control_point1: NSPoint, control_point2: NSPoint, )

pub unsafe fn curveToPoint_controlPoint( &self, end_point: NSPoint, control_point: NSPoint, )

pub unsafe fn closePath(&self)

pub unsafe fn removeAllPoints(&self)

pub unsafe fn relativeMoveToPoint(&self, point: NSPoint)

pub unsafe fn relativeLineToPoint(&self, point: NSPoint)

pub unsafe fn relativeCurveToPoint_controlPoint1_controlPoint2( &self, end_point: NSPoint, control_point1: NSPoint, control_point2: NSPoint, )

pub unsafe fn relativeCurveToPoint_controlPoint( &self, end_point: NSPoint, control_point: NSPoint, )

pub unsafe fn lineWidth(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setLineWidth(&self, line_width: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for lineWidth.

pub unsafe fn lineCapStyle(&self) -> NSLineCapStyle

pub unsafe fn setLineCapStyle(&self, line_cap_style: NSLineCapStyle)

Setter for lineCapStyle.

pub unsafe fn lineJoinStyle(&self) -> NSLineJoinStyle

pub unsafe fn setLineJoinStyle(&self, line_join_style: NSLineJoinStyle)

Setter for lineJoinStyle.

pub unsafe fn windingRule(&self) -> NSWindingRule

pub unsafe fn setWindingRule(&self, winding_rule: NSWindingRule)

Setter for windingRule.

pub unsafe fn miterLimit(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setMiterLimit(&self, miter_limit: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for miterLimit.

pub unsafe fn flatness(&self) -> CGFloat

Available on crate feature objc2-core-foundation only.

pub unsafe fn setFlatness(&self, flatness: CGFloat)

Available on crate feature objc2-core-foundation only.

Setter for flatness.

pub unsafe fn getLineDash_count_phase( &self, pattern: *mut CGFloat, count: *mut NSInteger, phase: *mut CGFloat, )

Available on crate feature objc2-core-foundation only.

pub unsafe fn setLineDash_count_phase( &self, pattern: *const CGFloat, count: NSInteger, phase: CGFloat, )

Available on crate feature objc2-core-foundation only.

pub unsafe fn stroke(&self)

pub unsafe fn fill(&self)

pub unsafe fn addClip(&self)

pub unsafe fn setClip(&self)

pub unsafe fn bezierPathByFlatteningPath(&self) -> Retained<NSBezierPath>

pub unsafe fn bezierPathByReversingPath(&self) -> Retained<NSBezierPath>

pub unsafe fn transformUsingAffineTransform( &self, transform: &NSAffineTransform, )

pub unsafe fn isEmpty(&self) -> bool

pub unsafe fn currentPoint(&self) -> NSPoint

pub unsafe fn controlPointBounds(&self) -> NSRect

pub unsafe fn bounds(&self) -> NSRect

pub unsafe fn elementCount(&self) -> NSInteger

pub unsafe fn elementAtIndex_associatedPoints( &self, index: NSInteger, points: NSPointArray, ) -> NSBezierPathElement

pub unsafe fn elementAtIndex(&self, index: NSInteger) -> NSBezierPathElement

pub unsafe fn setAssociatedPoints_atIndex( &self, points: NSPointArray, index: NSInteger, )

pub unsafe fn appendBezierPath(&self, path: &NSBezierPath)

pub unsafe fn appendBezierPathWithRect(&self, rect: NSRect)

pub unsafe fn appendBezierPathWithPoints_count( &self, points: NSPointArray, count: NSInteger, )

pub unsafe fn appendBezierPathWithOvalInRect(&self, rect: NSRect)

pub unsafe fn appendBezierPathWithArcWithCenter_radius_startAngle_endAngle_clockwise( &self, center: NSPoint, radius: CGFloat, start_angle: CGFloat, end_angle: CGFloat, clockwise: bool, )

Available on crate feature objc2-core-foundation only.

pub unsafe fn appendBezierPathWithArcWithCenter_radius_startAngle_endAngle( &self, center: NSPoint, radius: CGFloat, start_angle: CGFloat, end_angle: CGFloat, )

Available on crate feature objc2-core-foundation only.

pub unsafe fn appendBezierPathWithArcFromPoint_toPoint_radius( &self, point1: NSPoint, point2: NSPoint, radius: CGFloat, )

Available on crate feature objc2-core-foundation only.

pub unsafe fn appendBezierPathWithCGGlyph_inFont( &self, glyph: CGGlyph, font: &NSFont, )

Available on crate feature NSFont and crate feature objc2-core-graphics and Apple only.

pub unsafe fn appendBezierPathWithCGGlyphs_count_inFont( &self, glyphs: NonNull<CGGlyph>, count: NSInteger, font: &NSFont, )

Available on crate feature NSFont and crate feature objc2-core-graphics and Apple only.

pub unsafe fn appendBezierPathWithRoundedRect_xRadius_yRadius( &self, rect: NSRect, x_radius: CGFloat, y_radius: CGFloat, )

Available on crate feature objc2-core-foundation only.

pub unsafe fn containsPoint(&self, point: NSPoint) -> bool

impl NSBezierPath

Methods declared on superclass NSObject.

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

pub unsafe fn new() -> Retained<Self>

impl NSBezierPath

NSBezierPathDeprecated.

pub unsafe fn cachesBezierPath(&self) -> bool

👎Deprecated

pub unsafe fn setCachesBezierPath(&self, flag: bool)

👎Deprecated

pub unsafe fn appendBezierPathWithGlyph_inFont( &self, glyph: NSGlyph, font: &NSFont, )

👎Deprecated: Use -appendBezierPathWithCGGlyph:inFont: instead

Available on crate feature NSFont only.

pub unsafe fn appendBezierPathWithGlyphs_count_inFont( &self, glyphs: NonNull<NSGlyph>, count: NSInteger, font: &NSFont, )

👎Deprecated: Use -appendBezierPathWithCGGlyphs:count:inFont: instead

Available on crate feature NSFont only.

pub unsafe fn appendBezierPathWithPackedGlyphs( &self, packed_glyphs: NonNull<c_char>, )

👎Deprecated: Use -appendBezierPathWithCGGlyphs:count:inFont: instead

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Available on crate feature NSAccessibilityConstants only.

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Available on crate feature NSAccessibilityConstants only.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Available on crate feature NSAccessibilityConstants only.

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for NSBezierPath

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSBezierPath> for NSBezierPath

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for NSBezierPath

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for NSBezierPath

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSBezierPath

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSBezierPath

const NAME: &'static str = "NSBezierPath"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = <<NSBezierPath as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl CopyingHelper for NSBezierPath

type Result = NSBezierPath

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for NSBezierPath

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for NSBezierPath

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for NSBezierPath

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for NSBezierPath

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for NSBezierPath

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

where Self: Sized + Message,

impl NSCopying for NSBezierPath

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Returns a new instance that’s a copy of the receiver.

impl NSObjectProtocol for NSBezierPath

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl NSSecureCoding for NSBezierPath

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for NSBezierPath

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for NSBezierPath

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for NSBezierPath

impl Eq for NSBezierPath