Struct TrackingAreaOptions

pub struct TrackingAreaOptions(/* private fields */);

Tracking area options builder for NSPanel

Allows combining multiple tracking area options using the builder pattern. Tracking areas enable mouse event tracking within a specific region of a view.

Example

use tauri_nspanel::{TrackingAreaOptions, PanelBuilder};

// Track mouse movement and enter/exit events, active in any application state
let options = TrackingAreaOptions::new()
    .active_always()
    .mouse_entered_and_exited()
    .mouse_moved();

// Use with panel macro
panel!(MyPanel {
    with: {
        tracking_area: {
            options: options,
            auto_resize: true
        }
    }
});

// Or use with PanelBuilder
PanelBuilder::new(&app, "my-panel")
    .tracking_area(options, true)
    .build();

Implementations

impl TrackingAreaOptions

pub fn new() -> Self

Create empty tracking area options

pub fn mouse_moved(self) -> Self

Track mouse moved events

pub fn mouse_entered_and_exited(self) -> Self

Track mouse entered and exited events

pub fn active_always(self) -> Self

Track when mouse is active in any application

pub fn active_in_active_app(self) -> Self

Track when mouse is active in this application

pub fn active_in_key_window(self) -> Self

Track when mouse is active in key window

pub fn active_when_first_responder(self) -> Self

Track when window is key

pub fn assume_inside(self) -> Self

Assumes tracking area is active

pub fn in_visible_rect(self) -> Self

Tracking area is in visibleRect coordinates

pub fn cursor_update(self) -> Self

Enable cursor update events

pub fn from_raw(flags: NSTrackingAreaOptions) -> Self

Create from raw NSTrackingAreaOptions flags

pub fn value(&self) -> NSTrackingAreaOptions

Get the raw NSTrackingAreaOptions flags

Trait Implementations

impl Clone for TrackingAreaOptions

fn clone(&self) -> TrackingAreaOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TrackingAreaOptions

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

Formats the value using the given formatter.

impl Default for TrackingAreaOptions

fn default() -> Self

Returns the “default value” for a type.

impl From<NSTrackingAreaOptions> for TrackingAreaOptions

fn from(value: NSTrackingAreaOptions) -> Self

Converts to this type from the input type.

impl From<TrackingAreaOptions> for NSTrackingAreaOptions

fn from(options: TrackingAreaOptions) -> Self

Converts to this type from the input type.

impl PartialEq for TrackingAreaOptions

fn eq(&self, other: &TrackingAreaOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for TrackingAreaOptions

impl StructuralPartialEq for TrackingAreaOptions