Package apple.pencilkit

Class PKToolPicker

  • All Implemented Interfaces:
    NSObject
    public class PKToolPicker
extends NSObject
    A user interface for selecting a PKTool. API-Since: 13.0

    • Constructor Detail

      • PKToolPicker

        protected PKToolPicker​(org.moe.natj.general.Pointer peer)

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • addObserver

        public void addObserver​(@NotNull
                        @NotNull PKToolPickerObserver observer)
        Add an observer for a tool picker changes. Adding a `PKCanvasView` as an observer, will also set its initial state. Observers are held weakly.

      • allocWithZone

        public static PKToolPicker allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)

      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(@NotNull
                                                           @NotNull java.lang.String key)

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(@NotNull
                                                           @NotNull java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(@NotNull
                                                                         @NotNull java.lang.Object aTarget,
                                                                         @NotNull
                                                                         @NotNull org.moe.natj.objc.SEL aSelector,
                                                                         @Nullable
                                                                         @Nullable java.lang.Object anArgument)

      • classFallbacksForKeyedArchiver

        @NotNull
public static @NotNull NSArray<java.lang.String> classFallbacksForKeyedArchiver()

      • classForKeyedUnarchiver

        @NotNull
public static @NotNull org.moe.natj.objc.Class classForKeyedUnarchiver()

      • colorUserInterfaceStyle

        public long colorUserInterfaceStyle()
        Set `colorUserInterfaceStyle` to cause this tool picker to create colors for a canvas view of the specified user interface style. If this tool picker is used for selecting tools for canvas views that have different user interface styles, `colorUserInterfaceStyle` should be set to the canvas's user interface style. By default this is `UIUserInterfaceStyleUnspecified`.

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • description_static

        public static java.lang.String description_static()

      • frameObscuredInView

        public CGRect frameObscuredInView​(@NotNull
                                  @NotNull UIView view)
        The frame within a specific view that the tool picker covers.
        Parameters:
        view - The view in which to return the frame to avoid.
        Returns:
        The rect in `view` that the tool picker obscures. Will return `CGRectNull` if no rect is obscured, or the tool picker is movable.

      • hash_static

        public static long hash_static()

      • init

        public PKToolPicker init()
        Returns a new `PKToolPicker` instance. If two tool pickers are visible for the same first responder, or the same tool picker is visible in two windows the result is deterministic, but undefined. API-Since: 14.0
        Overrides:
        init in class NSObject

      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)

      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)

      • isRulerActive

        public boolean isRulerActive()
        Is the ruler toggled such that it should be active on canvases.

      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)

      • isVisible

        public boolean isVisible()
        Is the tool picker visible.

      • keyPathsForValuesAffectingValueForKey

        @NotNull
public static @NotNull NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(@NotNull
                                                                                     @NotNull java.lang.String key)

      • overrideUserInterfaceStyle

        public long overrideUserInterfaceStyle()
        Set `overrideUserInterfaceStyle` to cause this tool picker UI to have a specific user interface style. Consider if you need to set `colorUserInterfaceStyle` if you set this property. By default this is `UIUserInterfaceStyleUnspecified`.

      • removeObserver

        public void removeObserver​(@NotNull
                           @NotNull PKToolPickerObserver observer)
        Remove an observer for a tool picker changes.

      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)

      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)

      • selectedTool

        @NotNull
public @NotNull PKTool selectedTool()
        The currently selected tool.

      • setColorUserInterfaceStyle

        public void setColorUserInterfaceStyle​(long value)
        Set `colorUserInterfaceStyle` to cause this tool picker to create colors for a canvas view of the specified user interface style. If this tool picker is used for selecting tools for canvas views that have different user interface styles, `colorUserInterfaceStyle` should be set to the canvas's user interface style. By default this is `UIUserInterfaceStyleUnspecified`.

      • setOverrideUserInterfaceStyle

        public void setOverrideUserInterfaceStyle​(long value)
        Set `overrideUserInterfaceStyle` to cause this tool picker UI to have a specific user interface style. Consider if you need to set `colorUserInterfaceStyle` if you set this property. By default this is `UIUserInterfaceStyleUnspecified`.

      • setRulerActive

        public void setRulerActive​(boolean value)
        Is the ruler toggled such that it should be active on canvases.

      • setSelectedTool

        public void setSelectedTool​(@NotNull
                            @NotNull PKTool value)
        The currently selected tool.

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • setVisibleForFirstResponder

        public void setVisibleForFirstResponder​(boolean visible,
                                        @NotNull
                                        @NotNull UIResponder responder)
        Sets when this tool picker should be visible.
        Parameters:
        visible - The visible state of this tool picker.
        responder - The first responder for which this visible state applies.

      • sharedToolPickerForWindow

        @Nullable
@Deprecated
public static @Nullable PKToolPicker sharedToolPickerForWindow​(@NotNull
                                                               @NotNull UIWindow window)
        Deprecated.
        Returns the shared `PKToolPicker` instance for a window. The returned tool picker object is typically shared between windows in the same UIWindowScene. API-Since: 13.0 Deprecated-Since: 14.0 Deprecated-Message: Create individual instances instead.

      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()

      • version_static

        public static long version_static()

      • setShowsDrawingPolicyControls

        public void setShowsDrawingPolicyControls​(boolean value)
        If this is true the tool picker will show UI that allows the default drawing policy to be changed. By default this is true. API-Since: 14.0

      • setStateAutosaveName

        public void setStateAutosaveName​(@Nullable
                                 @Nullable java.lang.String value)
        The name used to automatically save the tool picker's state in the defaults system. API-Since: 14.0

      • showsDrawingPolicyControls

        public boolean showsDrawingPolicyControls()
        If this is true the tool picker will show UI that allows the default drawing policy to be changed. By default this is true. API-Since: 14.0

      • stateAutosaveName

        @Nullable
public @Nullable java.lang.String stateAutosaveName()
        The name used to automatically save the tool picker's state in the defaults system. API-Since: 14.0

      • maximumSupportedContentVersion

        public long maximumSupportedContentVersion()
        The maximum supported PencilKit content version. Setting this to less than `.latest` limits the tools that are available to select so that they are compatible with the specified version. If setting this property, also set it on `PKCanvasView`. Defaults to `.latest`. API-Since: 17.0

      • setMaximumSupportedContentVersion

        public void setMaximumSupportedContentVersion​(long value)
        The maximum supported PencilKit content version. Setting this to less than `.latest` limits the tools that are available to select so that they are compatible with the specified version. If setting this property, also set it on `PKCanvasView`. Defaults to `.latest`. API-Since: 17.0

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.