One Logo Pool Ball
SwiftUI · IOS API REFERENCE

KeyPress.Phases

struct · iOS 17.0+ · SDK 27.1

struct Phases

Options for matching different phases of a key-press event.

Members (7)

get · iOS 17.0+

debugDescription

TypeScript
getDebugDescription($self: KeyPress_Phases): string
Swift declaration
var debugDescription: String { get }

A textual representation of this instance, suitable for debugging. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(reflecting:)` initializer. This initializer works with any type, and uses the custom `debugDescription` property for types that conform to `CustomDebugStringConvertible`: struct Point: CustomDebugStringConvertible { let x: Int, y: Int var debugDescription: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(reflecting: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `debugDescription` property.

get · iOS 17.0+

up

TypeScript
get up(): KeyPress_Phases
Swift declaration
static let up: KeyPress.Phases

The user released a key.

get · iOS 17.0+

all

TypeScript
get all(): KeyPress_Phases
Swift declaration
static let all: KeyPress.Phases

A value that matches all key press phases.

get · iOS 17.0+

down

TypeScript
get down(): KeyPress_Phases
Swift declaration
static let down: KeyPress.Phases

The user pressed down on a key.

get · iOS 17.0+

repeat

TypeScript
get repeat(): KeyPress_Phases
Swift declaration
static let `repeat`: KeyPress.Phases

The user held a key down to issue a sequence of repeating events.

init · iOS 17.0+

init

TypeScript
init(rawValue: number): KeyPress_Phases
Swift declaration
init(rawValue: Int)

Creates a new option set from the given raw value. This initializer always succeeds, even if the value passed as `rawValue` exceeds the static properties declared as part of the option set. This example creates an instance of `ShippingOptions` with a raw value beyond the highest element, with a bit mask that effectively contains all the declared static members. let extraOptions = ShippingOptions(rawValue: 255) print(extraOptions.isStrictSuperset(of: .all)) // Prints "true" - Parameter rawValue: The raw value of the option set to create. Each bit of `rawValue` potentially represents an element of the option set, though raw values may include bits that are not defined as distinct values of the `OptionSet` type.

get · iOS 17.0+

rawValue

TypeScript
getRawValue($self: KeyPress_Phases): number
Swift declaration
let rawValue: Int

The corresponding value of the raw type. A new instance initialized with `rawValue` will be equivalent to this instance. For example: enum PaperSize: String { case A4, A5, Letter, Legal } let selectedSize = PaperSize.Letter print(selectedSize.rawValue) // Prints "Letter" print(selectedSize == PaperSize(rawValue: selectedSize.rawValue)!) // Prints "true"

Skipped declarations

No declarations were skipped in this snapshot.

All SwiftUI types →