元のドキュメント: developer.apple.com/documentation/watchkit/wkinterfaceobject


クラス


WKInterfaceObject


あなたの watchOS アプリ内のすべてのインターフェイスオブジェクトに共通する情報を提供するオブジェクト。


watchOS 2.0+

class WKInterfaceObject




以下で言及


ユーザーインターフェースとあなたのコードを接続する


概観


WatchKit 拡張機能では、Apple Watch に表示される視覚的要素を操作するためにインターフェイスオブジェクトを使用します。具体的には、このクラスのメソッドを使用して、それらの要素のサイズ、配置、および表示状態を変更します。また、VoiceOver などの支援技術を通じて表示されるアクセシビリティ情報を構成することも可能です。


このクラスやそのサブクラスを自分でサブクラス化したり、インスタンス化したりしないでください。代わりに、インターフェイスコントローラクラスでアウトレットを定義し、それらをストーリーボードファイル内の対応するオブジェクトに接続します。例えば、インターフェイス内のボタンを参照するには、インターフェイスコントローラクラスで以下のような構文を使用してプロパティを定義します。


SwiftObjective-C

@IBOutlet weak var button: WKInterfaceButton!

@property (weak, nonatomic) IBOutlet WKInterfaceButton* myButton;

実行時には、WatchKit は適切なインターフェイスオブジェクトを生成し、それらをあなたのインターフェイスコントローラのアウトレットに割り当てます。


WatchKit は、拡張機能(エクステンション)内のインターフェイスオブジェクトと、watchOS アプリ内の対応するインターフェイス要素との間で、一方向の通信を提供します。インターフェイスオブジェクトの値を設定することはできますが、現在の値を取得することはできません。属性の現在の値を知る必要がある場合は、その値を自分で保存しておかなければなりません。



Interface Builder の構成オプション


Xcode では、ストーリーボードファイル内のグループのインターフェイスオブジェクトに関する情報を構成できます。以下の表は、ストーリーボードで構成可能な属性とその意味をまとめたものです。


属性説明
Alpha
(アルファ)
オブジェクトの不透明度。値が 1.0 の場合は完全に不透明で、0.0 の場合は完全に透明であることを表します。
Hidden
(非表示)
項目が初期状態で非表示かどうかを示すチェックボックスです。setHidden(_:) メソッドを呼び出すことでプログラムから項目の表示状態を切り替えることができます。
Installed
(インストール済)
現在のデバイスにその項目がインストールされているかどうかを示すチェックボックス。
Horizontal
(水平)
項目の水平方向の配置です。この属性を使用して、直近の親要素に対する項目の水平位置を構成します。
Vertical
(垂直)
項目の垂直方向の配置です。この属性を使用して、直近の親要素に対する項目の垂直位置を構成します。
Width
(幅)
オブジェクトの幅。固定幅を指定するか、そのコンテナの幅に対するパーセンテージとして値を設定します。
Height
(高さ)
オブジェクトの高さ。固定の高さを指定するか、そのコンテナの高さに対するパーセンテージとして値を設定します。




トピックス


オブジェクトの非表示と表示


func setHidden(Bool)

あなたのユーザーインターフェイス内のインターフェイスオブジェクトを非表示または表示します。


func setAlpha(CGFloat)

インターフェースオブジェクトの不透明度を設定します。



プロパティ名の取得


var interfaceProperty: String

オブジェクトが結合されている、インターフェースコントローラ内のアウトレットの名前。



オブジェクトのサイズを変更する


func setWidth(CGFloat)

オブジェクトの絶対幅(ポイント単位)を設定します。


func setHeight(CGFloat)

オブジェクトの絶対値の高さ(ポイント単位)を設定します。


func setRelativeWidth(CGFloat, withAdjustment: CGFloat)

そのコンテナに対するオブジェクトの幅を設定します。


func setRelativeHeight(CGFloat, withAdjustment: CGFloat)

そのコンテナに対するオブジェクトの高さを設定します。


func sizeToFitWidth()

オブジェクトの幅を、その現在のコンテンツに合わせて設定します。


func sizeToFitHeight()

利用可能な垂直方向のスペースを埋めるように、オブジェクトの高さを設定します。



オブジェクトの配置を設定する


func setHorizontalAlignment(WKInterfaceObjectHorizontalAlignment)

オブジェクトの水平方向の配置を、そのオブジェクトのコンテナの境界を基準として設定します。


func setVerticalAlignment(WKInterfaceObjectVerticalAlignment)

オブジェクトの垂直方向の配置を、そのオブジェクトのコンテナの境界を基準として設定します。



アクセシビリティ属性の構成


func setAccessibilityIdentifier(String?)

インターフェースオブジェクトの一意の識別子文字列を設定します。


func setAccessibilityLabel(String?)

アクセシビリティ要素を識別する簡潔なラベルをオブジェクトに設定します。


func setAccessibilityHint(String?)

アクセシビリティ要素に対してアクションを実行した際に何が起こるかの説明を設定します。


func setAccessibilityValue(String?)

アクセシビリティ要素の値を設定します。


func setIsAccessibilityElement(Bool)

オブジェクトが、支援アプリがアクセスできるアクセシビリティ要素であるかどうかを設定します。


func setAccessibilityTraits(UIAccessibilityTraits)

アクセシビリティ要素を最もよく特徴づけるアクセシビリティ特性の組み合わせを設定します。


func setAccessibilityImageRegions([WKAccessibilityImageRegion])

イメージの一部を個別のアクセス可能な要素としてマークします。



レイアウト方向の設定


func setSemanticContentAttribute(WKInterfaceSemanticContentAttribute)

オブジェクトの内容の意味の説明を設定します。これは、左から右へのレイアウトと右から左へのレイアウトを切り替える際に、その内容を反転させるべきかどうかを判断するために使用されます。



定数


enum WKInterfaceObjectHorizontalAlignment

オブジェクトをコンテナ内で水平方向に整列させるための定数。


enum WKInterfaceObjectVerticalAlignment

オブジェクトをコンテナ内で垂直方向に整列させるための定数。





関連


以下から継承


NSObject



以下により継承


WKInterfaceActivityRing

WKInterfaceAuthorizationAppleIDButton

WKInterfaceButton

WKInterfaceDate

WKInterfaceGroup

WKInterfaceHMCamera

WKInterfaceImage

WKInterfaceInlineMovie

WKInterfaceLabel

WKInterfaceMap

WKInterfaceMovie

WKInterfacePaymentButton

WKInterfacePicker

WKInterfaceSCNScene

WKInterfaceSKScene

WKInterfaceSeparator

WKInterfaceSlider

WKInterfaceSwitch

WKInterfaceTable

WKInterfaceTextField

WKInterfaceTimer

WKInterfaceVolumeControl


以下に準拠


CVarArg

CustomDebugStringConvertible

CustomStringConvertible

Equatable

Hashable

NSObjectProtocol





以下も見よ


ユーザーインターフェースの基本


Storyboard を使用した watchOS アプリのインターフェースの構築

スタックをネストすることで、watchOS アプリのユーザーインターフェースを作成します。


class WKInterfaceController

watchOS アプリのインターフェースを管理するためのインフラストラクチャを提供するクラス。


class WKAlertAction

アラートまたはアクションシートに表示されるボタンに関する情報をカプセル化したオブジェクト。


class WKAccessibilityImageRegion

支援アプリに個別に呼び出したいイメージの一部を定義するオブジェクト。


func WKAccessibilityIsVoiceOverRunning() -> Bool

VoiceOver が実行中かどうかを示すブール値を返します。


func WKAccessibilityIsReduceMotionEnabled() -> Bool

動作低減機能が有効になっているかどうかを示すブール値を返します。














トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ












トップへ