Project: /_project.yaml Book: /_book.yaml

fuchsia.ui.policy

PROTOCOLS

DeviceListenerRegistry {:#DeviceListenerRegistry}

Defined in fuchsia.ui.policy/device_listener.fidl

Service for exposing state and events of devices, such as media buttons.

RegisterMediaButtonsListener {:#RegisterMediaButtonsListener}

Registers a listener to receive media button related events, such as changes from volume buttons and mute switches.

Request

KeyboardCaptureListenerHACK {:#KeyboardCaptureListenerHACK}

Defined in fuchsia.ui.policy/presentation.fidl

Presentation.CaptureKeyboardEvent will consume this listener interface and call OnEvent when the registered keyboard event occurs.

OnEvent {:#OnEvent}

Request

PointerCaptureListenerHACK {:#PointerCaptureListenerHACK}

Defined in fuchsia.ui.policy/presentation.fidl

Presentation.CapturePointerEvent will consume this listener interface and call OnEvent when a pointer event occurs.

OnPointerEvent {:#OnPointerEvent}

Request

MediaButtonsListener {:#MediaButtonsListener}

Defined in fuchsia.ui.policy/presentation.fidl

Presentation.RegisterMediaButtonsListener will consume this listener interface and call OnMediaButtonsEvent when the registered media buttons event occurs.

OnMediaButtonsEvent {:#OnMediaButtonsEvent}

Request

Presentation {:#Presentation}

Defined in fuchsia.ui.policy/presentation.fidl

Allows clients of Presenter.Present() to control a presentation. Experimental.

EnableClipping {:#EnableClipping}

Enable or disable clipping for the Scenic renderer associated with the presentation.

Request

UseOrthographicView {:#UseOrthographicView}

Request

UsePerspectiveView {:#UsePerspectiveView}

Request

SetRendererParams {:#SetRendererParams}

Set parameters such as the shadow algorithm used to render the scene. NOTE: a single param would be better than an array; see TO-529.

Request

SetDisplayUsage {:#SetDisplayUsage}

Override the intended usage of the display.

Request

SetDisplayRotation {:#SetDisplayRotation}

Rotates the display.

Request

SetDisplaySizeInMm {:#SetDisplaySizeInMm}

Override the dimensions of the display. Values must be less than the actual size of the display. If either of the values are 0, then they are ignored and the actual size of the display is used.

Request

CaptureKeyboardEventHACK {:#CaptureKeyboardEventHACK}

This call exists so that base shell can capture hotkeys and do special things with it (e.g., switch a session shell). Phase and modifiers are always matched, and valid (non-zero) code points are matched. If there is no valid code point, the filter will match against the hid usage value. The full KeyboardEvent is supplied to listener's OnEvent.

Request

CapturePointerEventsHACK {:#CapturePointerEventsHACK}

This call exists so that base shell can capture pointer events.

Request

GetPresentationMode {:#GetPresentationMode}

Request

Response

SetPresentationModeListener {:#SetPresentationModeListener}

Request

RegisterMediaButtonsListener {:#RegisterMediaButtonsListener}

Registers a listener for media buttons events.

Request

InjectPointerEventHACK {:#InjectPointerEventHACK}

EXPERIMENTAL. Inject pointer events into input stream. This WILL go away. Used exclusively by Session Shells to test focus navigation.

Request

PresentationModeListener {:#PresentationModeListener}

Defined in fuchsia.ui.policy/presentation.fidl

Tell client that the screen mode has changed, according to sensors. N.B. There can be a race where the actual mode continues to change, after the listener has been notified. The client must call GetPresentationMode(), which will return the latest detected mode.

OnModeChanged {:#OnModeChanged}

Request

Presenter {:#Presenter}

Defined in fuchsia.ui.policy/presenter.fidl

The Presenter service provides a way for applications to ask that a view be added to a view tree, leaving any window management concerns up to the discretion of the presenter implementation.

PresentView {:#PresentView}

Request that the View's contents be displayed on the screen as a Presentation.

Request

HACK_SetRendererParams {:#HACK_SetRendererParams}

Sets new default renderer params and forces them on for the duration of the presenter's lifetime. Only applies to any subsequent calls to Present(). Used for testing.

Request

DeviceListenerRegistry {:#DeviceListenerRegistry}

Defined in fuchsia.ui.policy/device_listener.fidl

Service for exposing state and events of devices, such as media buttons.

RegisterMediaButtonsListener {:#RegisterMediaButtonsListener}

Registers a listener to receive media button related events, such as changes from volume buttons and mute switches.

Request

KeyboardCaptureListenerHACK {:#KeyboardCaptureListenerHACK}

Defined in fuchsia.ui.policy/presentation.fidl

Presentation.CaptureKeyboardEvent will consume this listener interface and call OnEvent when the registered keyboard event occurs.

OnEvent {:#OnEvent}

Request

PointerCaptureListenerHACK {:#PointerCaptureListenerHACK}

Defined in fuchsia.ui.policy/presentation.fidl

Presentation.CapturePointerEvent will consume this listener interface and call OnEvent when a pointer event occurs.

OnPointerEvent {:#OnPointerEvent}

Request

MediaButtonsListener {:#MediaButtonsListener}

Defined in fuchsia.ui.policy/presentation.fidl

Presentation.RegisterMediaButtonsListener will consume this listener interface and call OnMediaButtonsEvent when the registered media buttons event occurs.

OnMediaButtonsEvent {:#OnMediaButtonsEvent}

Request

Presentation {:#Presentation}

Defined in fuchsia.ui.policy/presentation.fidl

Allows clients of Presenter.Present() to control a presentation. Experimental.

EnableClipping {:#EnableClipping}

Enable or disable clipping for the Scenic renderer associated with the presentation.

Request

UseOrthographicView {:#UseOrthographicView}

Request

UsePerspectiveView {:#UsePerspectiveView}

Request

SetRendererParams {:#SetRendererParams}

Set parameters such as the shadow algorithm used to render the scene. NOTE: a single param would be better than an array; see TO-529.

Request

SetDisplayUsage {:#SetDisplayUsage}

Override the intended usage of the display.

Request

SetDisplayRotation {:#SetDisplayRotation}

Rotates the display.

Request

SetDisplaySizeInMm {:#SetDisplaySizeInMm}

Override the dimensions of the display. Values must be less than the actual size of the display. If either of the values are 0, then they are ignored and the actual size of the display is used.

Request

CaptureKeyboardEventHACK {:#CaptureKeyboardEventHACK}

This call exists so that base shell can capture hotkeys and do special things with it (e.g., switch a session shell). Phase and modifiers are always matched, and valid (non-zero) code points are matched. If there is no valid code point, the filter will match against the hid usage value. The full KeyboardEvent is supplied to listener's OnEvent.

Request

CapturePointerEventsHACK {:#CapturePointerEventsHACK}

This call exists so that base shell can capture pointer events.

Request

GetPresentationMode {:#GetPresentationMode}

Request

Response

SetPresentationModeListener {:#SetPresentationModeListener}

Request

RegisterMediaButtonsListener {:#RegisterMediaButtonsListener}

Registers a listener for media buttons events.

Request

InjectPointerEventHACK {:#InjectPointerEventHACK}

EXPERIMENTAL. Inject pointer events into input stream. This WILL go away. Used exclusively by Session Shells to test focus navigation.

Request

PresentationModeListener {:#PresentationModeListener}

Defined in fuchsia.ui.policy/presentation.fidl

Tell client that the screen mode has changed, according to sensors. N.B. There can be a race where the actual mode continues to change, after the listener has been notified. The client must call GetPresentationMode(), which will return the latest detected mode.

OnModeChanged {:#OnModeChanged}

Request

Presenter {:#Presenter}

Defined in fuchsia.ui.policy/presenter.fidl

The Presenter service provides a way for applications to ask that a view be added to a view tree, leaving any window management concerns up to the discretion of the presenter implementation.

PresentView {:#PresentView}

Request that the View's contents be displayed on the screen as a Presentation.

Request

HACK_SetRendererParams {:#HACK_SetRendererParams}

Sets new default renderer params and forces them on for the duration of the presenter's lifetime. Only applies to any subsequent calls to Present(). Used for testing.

Request

ENUMS

DisplayUsage {:#DisplayUsage}

Type: uint32

Defined in fuchsia.ui.policy/display_usage.fidl

Describes the intended usage of the display.

PresentationMode {:#PresentationMode}

Type: uint32

Defined in fuchsia.ui.policy/presentation.fidl

Screen modes that can be detected via sensor data. N.B. We use accelerometers to measure gravity when at rest, so detection is limited to earth-relative orientations.

DisplayUsage {:#DisplayUsage}

Type: uint32

Defined in fuchsia.ui.policy/display_usage.fidl

Describes the intended usage of the display.

PresentationMode {:#PresentationMode}

Type: uint32

Defined in fuchsia.ui.policy/presentation.fidl

Screen modes that can be detected via sensor data. N.B. We use accelerometers to measure gravity when at rest, so detection is limited to earth-relative orientations.