Skip to main content
KeyOS API Reference

GuiApi

gui_server_api

Struct GuiApi 

Source 
pub struct GuiApi<P: CheckedPermissions> { /* private fields */ }
Expand description

Full GUI API, usable by GUI apps

Implementations§

Source§

impl<P: CheckedPermissions> GuiApi<P>

Source

pub fn navigate_finish(&self, response: Vec<u8>) -> Result<(), GuiServerError>
where P: MessageAllowed<FinishResponse>,

Permission: os/gui-server / FinishResponse

Permission group: ui-and-input.navigation-response

Required signature: thirdParty

Approval: autoAllow

Source

pub fn navigate_cancel(&self) -> Result<(), GuiServerError>
where P: MessageAllowed<NavigationCancel>,

Permission: os/gui-server / NavigationCancel

Permission group: ui-and-input.navigation-response

Required signature: thirdParty

Approval: autoAllow

Source

pub fn navigate_pending(&self) -> Result<Option<Vec<u8>>, GuiServerError>
where P: MessageAllowed<GetPendingNavRequest>,

Permission: os/gui-server / GetPendingNavRequest

Permission group: ui-and-input.navigation-response

Required signature: thirdParty

Approval: autoAllow

Source§

impl<P: CheckedPermissions> GuiApi<P>

Source

pub fn register(name: &str, height: usize) -> Result<Self, GuiServerError>
where P: MessageAllowed<RegisterAppMessage>,

Permission: os/gui-server / RegisterAppMessage

Permission group: ui-and-input.app-surface

Required signature: thirdParty

Approval: autoAllow

Registers an ordinary app window.

Source

pub fn set_control_center_color( &self, color: Option<ControlCenterColor>, ) -> Result<(), GuiServerError>
where P: MessageAllowed<SetControlCenterColor>,

Permission: os/gui-server / SetControlCenterColor

Permission group: ui-and-input.control-center-appearance

Required signature: thirdParty

Approval: autoAllow

Requests a background color for the collapsed Control Center while this app is visible.

Passing None restores the system theme color

Source

pub fn sid(&self) -> SID

Permission: not needed

Source

pub fn submit_frame(&self, buffer: MemoryRange) -> Result<(), GuiServerError>
where P: MessageAllowed<SubmitFrame>,

Permission: os/gui-server / SubmitFrame

Permission group: ui-and-input.app-surface

Required signature: thirdParty

Approval: autoAllow

Submit a frame for display.

Source

pub fn show_camera(&self, y_pos: u16) -> Result<(), GuiServerError>
where P: MessageAllowed<ShowCamera>,

Permission: os/gui-server / ShowCamera

Permission group: peripherals.camera-use

Required signature: thirdParty

Approval: grantOnFirstUse

Source

pub fn hide_camera(&self) -> Result<(), GuiServerError>
where P: MessageAllowed<HideCamera>,

Permission: os/gui-server / HideCamera

Permission group: peripherals.camera-use

Required signature: thirdParty

Approval: grantOnFirstUse

Source

pub fn update_keyboard(&self, msg: UpdateKeyboard) -> Result<(), GuiServerError>
where P: MessageAllowed<UpdateKeyboard>,

Permission: os/gui-server / UpdateKeyboard

Permission group: ui-and-input.keyboard-request

Required signature: thirdParty

Approval: autoAllow

Source

pub fn hide_keyboard(&self) -> Result<(), GuiServerError>
where P: MessageAllowed<HideKeyboard>,

Permission: os/gui-server / HideKeyboard

Permission group: ui-and-input.keyboard-request

Required signature: thirdParty

Approval: autoAllow

Source

pub fn wake_event_loop(&self)

Permission: not needed

Source

pub fn request_redraw(&self) -> Result<(), GuiServerError>
where P: MessageAllowed<RequestRedraw>,

Permission: os/gui-server / RequestRedraw

Permission group: ui-and-input.app-surface

Required signature: thirdParty

Approval: autoAllow

Source

pub fn try_receive_input(&self) -> Option<(InputMessage, MessageEnvelope)>

Permission: not needed

Source

pub fn receive_input( &self, ) -> Result<(InputMessage, MessageEnvelope), GuiServerError>

Permission: not needed

Source

pub fn animate_next_frame( &self, animation_kind: NextFrameAnimationKind, ) -> Result<(), GuiServerError>
where P: MessageAllowed<AnimateNextFrame>,

Permission: os/gui-server / AnimateNextFrame

Permission group: ui-and-input.app-surface

Required signature: thirdParty

Approval: autoAllow

Methods from Deref<Target = GuiApiLight<P>>§

Source

pub fn show_modal( &self, app_id: AppId, modal_style: ModalStyle, args: &[u8], ) -> Result<NavigationResult, GuiServerError>
where P: MessageAllowed<ShowModal>,

Permission: os/gui-server / ShowModal

Permission group: ui-and-input.brokered-modal

Required signature: thirdParty

Approval: grantOnFirstUse

Shows a modal of the app, giving it a navigation object

Source

pub fn invoke_alert( &self, alert: InvokeAlert, ) -> Result<AlertResult, GuiServerError>
where P: MessageAllowed<ShowModal>,

Permission: os/gui-server / ShowModal

Permission group: ui-and-input.brokered-modal

Required signature: thirdParty

Approval: grantOnFirstUse

Trait Implementations§

Source§

impl<P: Debug + CheckedPermissions> Debug for GuiApi<P>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<P: CheckedPermissions> Deref for GuiApi<P>

Source§

type Target = GuiApiLight<P>

The resulting type after dereferencing.
Source§

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

Dereferences the value.
Source§

impl<P: CheckedPermissions> Drop for GuiApi<P>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<P> Freeze for GuiApi<P>

§

impl<P> RefUnwindSafe for GuiApi<P>

§

impl<P> Send for GuiApi<P>

§

impl<P> Sync for GuiApi<P>

§

impl<P> Unpin for GuiApi<P>

§

impl<P> UnsafeUnpin for GuiApi<P>

§

impl<P> UnwindSafe for GuiApi<P>

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> ArchivePointee for T

§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

§

impl<T> LayoutRaw for T

§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
§

impl<T> Pointee for T

§

type Metadata = ()

The metadata type for pointers and references to this type.
§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.