Struct gpui2::AppContext

pub struct AppContext { /* private fields */ }

Implementations

impl AppContext

pub fn shutdown(&mut self)

Quit the application gracefully. Handlers registered with ModelContext::on_app_quit will be given 100ms to complete before exiting.

pub fn quit(&mut self)

pub fn app_metadata(&self) -> AppMetadata

pub fn refresh(&mut self)

Schedules all windows in the application to be redrawn. This can be called multiple times in an update cycle and still result in a single redraw.

pub fn observe<W, E>( &mut self, entity: &E, on_notify: impl FnMut(E, &mut AppContext) + 'static ) -> Subscriptionwhere W: 'static, E: Entity<W>,

pub fn observe_internal<W, E>( &mut self, entity: &E, on_notify: impl FnMut(E, &mut AppContext) -> bool + 'static ) -> Subscriptionwhere W: 'static, E: Entity<W>,

pub fn subscribe<T, E, Evt>( &mut self, entity: &E, on_event: impl FnMut(E, &Evt, &mut AppContext) + 'static ) -> Subscriptionwhere T: 'static + EventEmitter<Evt>, E: Entity<T>, Evt: 'static,

pub fn windows(&self) -> Vec<AnyWindowHandle>

pub fn open_window<V: 'static + Render>( &mut self, options: WindowOptions, build_root_view: impl FnOnce(&mut WindowContext<'_>) -> View<V> ) -> WindowHandle<V>

Opens a new window with the given option and the root view returned by the given function. The function is invoked with a WindowContext, which can be used to interact with window-specific functionality.

pub fn activate(&self, ignoring_other_apps: bool)

Instructs the platform to activate the application by bringing it to the foreground.

pub fn hide(&self)

pub fn hide_other_apps(&self)

pub fn unhide_other_apps(&self)

pub fn displays(&self) -> Vec<Rc<dyn PlatformDisplay>>

Returns the list of currently active displays.

pub fn write_to_clipboard(&self, item: ClipboardItem)

Writes data to the platform clipboard.

pub fn read_from_clipboard(&self) -> Option<ClipboardItem>

Reads data from the platform clipboard.

pub fn write_credentials( &self, url: &str, username: &str, password: &[u8] ) -> Result<()>

Writes credentials to the platform keychain.

pub fn read_credentials(&self, url: &str) -> Result<Option<(String, Vec<u8>)>>

Reads credentials from the platform keychain.

pub fn delete_credentials(&self, url: &str) -> Result<()>

Deletes credentials from the platform keychain.

pub fn open_url(&self, url: &str)

Directs the platform’s default browser to open the given URL.

pub fn app_path(&self) -> Result<PathBuf>

pub fn path_for_auxiliary_executable(&self, name: &str) -> Result<PathBuf>

pub fn prompt_for_paths( &self, options: PathPromptOptions ) -> Receiver<Option<Vec<PathBuf>>>

pub fn prompt_for_new_path(&self, directory: &Path) -> Receiver<Option<PathBuf>>

pub fn reveal_path(&self, path: &Path)

pub fn should_auto_hide_scrollbars(&self) -> bool

pub fn to_async(&self) -> AsyncAppContext

Creates an AsyncAppContext, which can be cloned and has a static lifetime so it can be held across await points.

pub fn background_executor(&self) -> &BackgroundExecutor

Obtains a reference to the executor, which can be used to spawn futures.

pub fn foreground_executor(&self) -> &ForegroundExecutor

Obtains a reference to the executor, which can be used to spawn futures.

pub fn spawn<Fut, R>(&self, f: impl FnOnce(AsyncAppContext) -> Fut) -> Task<R> where Fut: Future<Output = R> + 'static, R: 'static,

Spawns the future returned by the given function on the thread pool. The closure will be invoked with AsyncAppContext, which allows the application state to be accessed across await points.

pub fn defer(&mut self, f: impl FnOnce(&mut AppContext) + 'static)

Schedules the given function to be run at the end of the current effect cycle, allowing entities that are currently on the stack to be returned to the app.

pub fn asset_source(&self) -> &Arc<dyn AssetSource>

Accessor for the application’s asset source, which is provided when constructing the App.

pub fn text_system(&self) -> &Arc<TextSystem>

Accessor for the text system.

pub fn text_style(&self) -> TextStyle

The current text style. Which is composed of all the style refinements provided to with_text_style.

pub fn has_global<G: 'static>(&self) -> bool

Check whether a global of the given type has been assigned.

pub fn global<G: 'static>(&self) -> &G

Access the global of the given type. Panics if a global for that type has not been assigned.

pub fn try_global<G: 'static>(&self) -> Option<&G>

Access the global of the given type if a value has been assigned.

pub fn global_mut<G: 'static>(&mut self) -> &mut G

Access the global of the given type mutably. Panics if a global for that type has not been assigned.

pub fn default_global<G: 'static + Default>(&mut self) -> &mut G

Access the global of the given type mutably. A default value is assigned if a global of this type has not yet been assigned.

pub fn set_global<G: Any>(&mut self, global: G)

Set the value of the global of the given type.

pub fn update_global<G: 'static, R>( &mut self, f: impl FnOnce(&mut G, &mut Self) -> R ) -> R

Update the global of the given type with a closure. Unlike global_mut, this method provides your closure with mutable access to the AppContext and the global simultaneously.

pub fn observe_global<G: 'static>( &mut self, f: impl FnMut(&mut Self) + 'static ) -> Subscription

Register a callback to be invoked when a global of the given type is updated.

pub fn observe_new_views<V: 'static>( &mut self, on_new: impl 'static + Fn(&mut V, &mut ViewContext<'_, V>) ) -> Subscription

pub fn observe_release<E, T>( &mut self, handle: &E, on_release: impl FnOnce(&mut T, &mut AppContext) + 'static ) -> Subscriptionwhere E: Entity<T>, T: 'static,

pub fn bind_keys(&mut self, bindings: impl IntoIterator<Item = KeyBinding>)

Register key bindings.

pub fn on_action<A: Action>( &mut self, listener: impl Fn(&A, &mut Self) + 'static )

Register a global listener for actions invoked via the keyboard.

pub fn stop_propagation(&mut self)

Event handlers propagate events by default. Call this method to stop dispatching to event handlers with a lower z-index (mouse) or higher in the tree (keyboard). This is the opposite of [propagate]. It’s also possible to cancel a call to [propagate] by calling this method before effects are flushed.

pub fn propagate(&mut self)

Action handlers stop propagation by default during the bubble phase of action dispatch dispatching to action handlers higher in the element tree. This is the opposite of [stop_propagation]. It’s also possible to cancel a call to [stop_propagate] by calling this method before effects are flushed.

pub fn build_action( &self, name: &str, data: Option<Value> ) -> Result<Box<dyn Action>>

pub fn all_action_names(&self) -> &[SharedString]

Trait Implementations

impl<T> Borrow<AppContext> for ModelContext<'_, T>

fn borrow(&self) -> &AppContext

Immutably borrows from an owned value.

impl<V> Borrow<AppContext> for ViewContext<'_, V>

fn borrow(&self) -> &AppContext

Immutably borrows from an owned value.

impl<'a> Borrow<AppContext> for WindowContext<'a>

fn borrow(&self) -> &AppContext

Immutably borrows from an owned value.

impl<T> BorrowMut<AppContext> for ModelContext<'_, T>

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

Mutably borrows from an owned value.

impl<V> BorrowMut<AppContext> for ViewContext<'_, V>

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

Mutably borrows from an owned value.

impl<'a> BorrowMut<AppContext> for WindowContext<'a>

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

Mutably borrows from an owned value.

impl Context for AppContext

fn build_model<T: 'static>( &mut self, build_model: impl FnOnce(&mut ModelContext<'_, T>) -> T ) -> Model<T>

Build an entity that is owned by the application. The given function will be invoked with a ModelContext and must return an object representing the entity. A Model will be returned which can be used to access the entity in a context.

fn update_model<T: 'static, R>( &mut self, model: &Model<T>, update: impl FnOnce(&mut T, &mut ModelContext<'_, T>) -> R ) -> R

Update the entity referenced by the given model. The function is passed a mutable reference to the entity along with a ModelContext for the entity.

type Result<T> = T

fn update_window<T, F>( &mut self, handle: AnyWindowHandle, update: F ) -> Result<T>where F: FnOnce(AnyView, &mut WindowContext<'_>) -> T,

fn read_model<T, R>( &self, handle: &Model<T>, read: impl FnOnce(&T, &AppContext) -> R ) -> Self::Result<R>where T: 'static,

fn read_window<T, R>( &self, window: &WindowHandle<T>, read: impl FnOnce(View<T>, &AppContext) -> R ) -> Result<R>where T: 'static,