refactor!: improve surface action handling and adjust libcosmic API

This commit is contained in:
Michael Aaron Murphy 2025-03-05 16:01:23 +01:00 • committed by Ashley Wulber
parent 2c10e4362a
commit adb08f9daf
No known key found for this signature in database
GPG key ID: 5216D4F46A90A820
23 changed files with 755 additions and 799 deletions

View file

@ -100,6 +100,12 @@ pub mod autosize;
#[cfg(feature = "winit")]
pub(crate) mod responsive_container;
#[cfg(feature = "surface-message")]
mod responsive_menu_bar;
#[cfg(feature = "surface-message")]
#[doc(inline)]
pub use responsive_menu_bar::responsive_menu_bar;
pub mod button;
#[doc(inline)]
pub use button::{Button, IconButton, LinkButton, TextButton};

View file

@ -9,18 +9,17 @@ use iced_core::renderer;
use iced_core::widget::{tree, Id, Tree};
use iced_core::{Clipboard, Element, Layout, Length, Rectangle, Shell, Vector, Widget};
use crate::surface_message::SurfaceMessage;
pub(crate) fn responsive_container<'a, Message: 'static + From<SurfaceMessage>, Theme, E>(
pub(crate) fn responsive_container<'a, Message: 'static, Theme, E>(
content: E,
id: Id,
on_action: impl Fn(crate::surface::Action) -> Message + 'static,
) -> ResponsiveContainer<'a, Message, Theme, crate::Renderer>
where
E: Into<Element<'a, Message, Theme, crate::Renderer>>,
Theme: iced_widget::container::Catalog,
<Theme as iced_widget::container::Catalog>::Class<'a>: From<crate::theme::Container<'a>>,
{
ResponsiveContainer::new(content, id)
ResponsiveContainer::new(content, id, on_action)
}
/// An element decorating some content.
@ -34,6 +33,7 @@ where
content: Element<'a, Message, Theme, Renderer>,
id: Id,
size: Option<Size>,
on_action: Box<dyn Fn(crate::surface::Action) -> Message>,
}
impl<'a, Message, Theme, Renderer> ResponsiveContainer<'a, Message, Theme, Renderer>
@ -41,7 +41,11 @@ where
Renderer: iced_core::Renderer,
{
/// Creates an empty [`IdContainer`].
pub(crate) fn new<T>(content: T, id: Id) -> Self
pub(crate) fn new<T>(
content: T,
id: Id,
on_action: impl Fn(crate::surface::Action) -> Message + 'static,
) -> Self
where
T: Into<Element<'a, Message, Theme, Renderer>>,
{
@ -49,6 +53,7 @@ where
content: content.into(),
id,
size: None,
on_action: Box::new(on_action),
}
}
@ -62,7 +67,6 @@ impl<Message, Theme, Renderer> Widget<Message, Theme, Renderer>
for ResponsiveContainer<'_, Message, Theme, Renderer>
where
Renderer: iced_core::Renderer,
Message: From<SurfaceMessage>,
{
fn tag(&self) -> tree::Tag {
tree::Tag::of::<State>()
@ -148,11 +152,13 @@ where
let state = tree.state.downcast_mut::<State>();
if state.needs_update {
shell.publish(Message::from(SurfaceMessage::ResponsiveMenuBar {
menu_bar: self.id.clone(),
limits: state.limits,
size: state.size,
}));
shell.publish((self.on_action)(
crate::surface::Action::ResponsiveMenuBar {
menu_bar: self.id.clone(),
limits: state.limits,
size: state.size,
},
));
state.needs_update = false;
}
@ -264,7 +270,7 @@ where
impl<'a, Message, Theme, Renderer> From<ResponsiveContainer<'a, Message, Theme, Renderer>>
for Element<'a, Message, Theme, Renderer>
where
Message: 'a + From<SurfaceMessage>,
Message: 'a,
Renderer: 'a + iced_core::Renderer,
Theme: 'a,
{

View file

@ -0,0 +1,78 @@
use std::collections::HashMap;
use apply::Apply;
use crate::{
widget::{button, icon, responsive_container},
Core, Element,
};
use super::menu;
/// # Panics
///
/// Will panic if the menu bar collapses without tracking the size
pub fn responsive_menu_bar<'a, Message: Clone + 'static, A: menu::Action<Message = Message>>(
core: &Core,
key_binds: &HashMap<menu::KeyBind, A>,
id: crate::widget::Id,
action_message: impl Fn(crate::surface::Action) -> Message + 'static,
trees: Vec<(
std::borrow::Cow<'static, str>,
Vec<menu::Item<A, std::borrow::Cow<'static, str>>>,
)>,
) -> Element<'a, Message> {
use crate::widget::id_container;
let menu_bar_size = core.menu_bars.get(&id);
#[allow(clippy::if_not_else)]
if !menu_bar_size.is_some_and(|(limits, size)| {
let max_size = limits.max();
max_size.width < size.width
}) {
responsive_container::responsive_container(
id_container(
menu::bar(
trees
.into_iter()
.map(|mt| {
menu::Tree::<_>::with_children(
menu::root(mt.0),
menu::items(key_binds, mt.1),
)
})
.collect(),
),
crate::widget::Id::new(format!("menu_bar_expanded_{id}")),
),
id,
action_message,
)
.apply(Element::from)
} else {
responsive_container::responsive_container(
id_container(
menu::bar(vec![menu::Tree::<_>::with_children(
Element::from(
button::icon(icon::from_name("open-menu-symbolic"))
.padding([4, 12])
.class(crate::theme::Button::MenuRoot),
),
menu::items(
key_binds,
trees
.into_iter()
.map(|mt| menu::Item::Folder(mt.0, mt.1))
.collect(),
),
)]),
crate::widget::Id::new(format!("menu_bar_collapsed_{id}")),
),
id,
action_message,
)
.size(menu_bar_size.unwrap().1)
.apply(Element::from)
}
}

View file

@ -14,7 +14,7 @@ use iced::Task;
use iced_runtime::core::widget::Id;
use iced_core::event::{self, Event};
use iced_core::renderer::{self, Renderer};
use iced_core::renderer;
use iced_core::touch;
use iced_core::widget::tree::{self, Tree};
use iced_core::widget::Operation;
@ -25,8 +25,6 @@ use iced_core::{
Background, Clipboard, Color, Layout, Length, Padding, Point, Rectangle, Shell, Vector, Widget,
};
use crate::surface_message::SurfaceMessage;
pub use super::{Catalog, Style};
/// Internally defines different button widget variants.
@ -41,7 +39,7 @@ enum Variant<Message> {
/// A generic button which emits a message when pressed.
#[allow(missing_debug_implementations)]
#[must_use]
pub struct Tooltip<'a, Message, AppMessage> {
pub struct Tooltip<'a, Message> {
id: Id,
#[cfg(feature = "a11y")]
name: Option<std::borrow::Cow<'a, str>>,
@ -51,6 +49,7 @@ pub struct Tooltip<'a, Message, AppMessage> {
label: Option<Vec<iced_accessibility::accesskit::NodeId>>,
content: crate::Element<'a, Message>,
on_leave: Message,
on_surface_action: Box<dyn Fn(crate::surface::Action) -> Message>,
width: Length,
height: Length,
padding: Padding,
@ -65,15 +64,10 @@ pub struct Tooltip<'a, Message, AppMessage> {
+ 'static,
>,
>,
view: Arc<
dyn Fn() -> crate::Element<'static, crate::app::Message<AppMessage>>
+ Send
+ Sync
+ 'static,
>,
view: Arc<dyn Fn() -> crate::Element<'static, Message> + Send + Sync + 'static>,
}
impl<'a, Message, AppMessage> Tooltip<'a, Message, AppMessage> {
impl<'a, Message> Tooltip<'a, Message> {
/// Creates a new [`Tooltip`] with the given content.
pub fn new(
content: impl Into<crate::Element<'a, Message>>,
@ -83,11 +77,9 @@ impl<'a, Message, AppMessage> Tooltip<'a, Message, AppMessage> {
+ Sync
+ 'static,
>,
view: impl Fn() -> crate::Element<'static, crate::app::Message<AppMessage>>
+ Send
+ Sync
+ 'static,
view: impl Fn() -> crate::Element<'static, Message> + Send + Sync + 'static,
on_leave: Message,
on_surface_action: impl Fn(crate::surface::Action) -> Message + 'static,
) -> Self {
Self {
id: Id::unique(),
@ -104,6 +96,7 @@ impl<'a, Message, AppMessage> Tooltip<'a, Message, AppMessage> {
selected: false,
style: crate::theme::Tooltip::default(),
on_leave,
on_surface_action: Box::new(on_surface_action),
delay: None,
settings: if let Some(s) = settings {
Some(Arc::new(s))
@ -189,11 +182,8 @@ impl<'a, Message, AppMessage> Tooltip<'a, Message, AppMessage> {
}
}
impl<
'a,
Message: 'a + Clone + From<SurfaceMessage>,
AppMessage: Clone + 'static + From<SurfaceMessage>,
> Widget<Message, crate::Theme, crate::Renderer> for Tooltip<'a, Message, AppMessage>
impl<'a, Message: 'static + Clone> Widget<Message, crate::Theme, crate::Renderer>
for Tooltip<'a, Message>
{
fn tag(&self) -> tree::Tag {
tree::Tag::of::<State>()
@ -273,6 +263,7 @@ impl<
&self.view,
self.delay,
&self.on_leave,
&self.on_surface_action,
|| tree.state.downcast_mut::<State>(),
);
status.merge(self.content.as_widget_mut().on_event(
@ -390,13 +381,8 @@ impl<
}
}
impl<
'a,
Message: From<SurfaceMessage> + Clone + 'a,
AppMessage: From<SurfaceMessage> + Clone + 'static,
> From<Tooltip<'a, Message, AppMessage>> for crate::Element<'a, Message>
{
fn from(button: Tooltip<'a, Message, AppMessage>) -> Self {
impl<'a, Message: Clone + 'static> From<Tooltip<'a, Message>> for crate::Element<'a, Message> {
fn from(button: Tooltip<'a, Message>) -> Self {
Self::new(button)
}
}
@ -419,11 +405,7 @@ impl State {
/// Processes the given [`Event`] and updates the [`State`] of a [`Tooltip`]
/// accordingly.
#[allow(clippy::needless_pass_by_value)]
pub fn update<
'a,
Message: Clone + From<SurfaceMessage>,
AppMessage: Clone + 'a + From<SurfaceMessage> + 'static,
>(
pub fn update<'a, Message: Clone + 'static>(
_id: Id,
event: Event,
layout: Layout<'_>,
@ -437,14 +419,10 @@ pub fn update<
+ 'static,
>,
>,
view: &Arc<
dyn Fn() -> crate::Element<'static, crate::app::Message<AppMessage>>
+ Send
+ Sync
+ 'static,
>,
view: &Arc<dyn Fn() -> crate::Element<'static, Message> + Send + Sync + 'static>,
delay: Option<Duration>,
on_leave: &Message,
on_surface_action: &dyn Fn(crate::surface::Action) -> Message,
state: impl FnOnce() -> &'a mut State,
) -> event::Status {
match event {
@ -491,46 +469,44 @@ pub fn update<
let view = view.clone();
let bounds = layout.bounds();
shell.publish(
SurfaceMessage::Task(Arc::new(move || {
let s = s.clone();
let view = view.clone();
let is_hovered = is_hovered.clone();
Task::future(async move {
_ = tokio::time::sleep(delay).await;
let sm = crate::surface::Action::Task(Arc::new(move || {
let s = s.clone();
let view = view.clone();
let is_hovered = is_hovered.clone();
Task::future(async move {
_ = tokio::time::sleep(delay).await;
let is_hovered = is_hovered.clone();
let g = is_hovered.lock().unwrap();
if !*g {
return SurfaceMessage::Ignore;
}
let boxed: Box<
dyn Fn() -> iced_runtime::platform_specific::wayland::popup::SctkPopupSettings
+ Send
+ Sync
+ 'static,
> = Box::new(move || s(bounds));
let boxed: Box<dyn Any + Send + Sync + 'static> = Box::new(boxed);
SurfaceMessage::Popup(
Arc::new(boxed),
Some({
let boxed: Box<
dyn Fn() -> crate::Element<
'static,
crate::app::Message<AppMessage>,
> + Send
+ Sync
+ 'static,
> = Box::new(move || view());
let boxed: Box<dyn Any + Send + Sync + 'static> =
Box::new(boxed);
Arc::new(boxed)
}),
)
})
}))
.into(),
);
let is_hovered = is_hovered.clone();
let g = is_hovered.lock().unwrap();
if !*g {
return crate::surface::Action::Ignore;
}
let boxed: Box<
dyn Fn() -> iced_runtime::platform_specific::wayland::popup::SctkPopupSettings
+ Send
+ Sync
+ 'static,
> = Box::new(move || s(bounds));
let boxed: Box<dyn Any + Send + Sync + 'static> =
Box::new(boxed);
crate::surface::Action::Popup(
Arc::new(boxed),
Some({
let boxed: Box<
dyn Fn() -> crate::Element<'static, Message>
+ Send
+ Sync
+ 'static,
> = Box::new(move || view());
let boxed: Box<dyn Any + Send + Sync + 'static> =
Box::new(boxed);
Arc::new(boxed)
}),
)
})
}));
shell.publish((on_surface_action)(sm));
} else {
let s = settings.clone();
let view = view.clone();
@ -544,14 +520,12 @@ pub fn update<
> = Box::new(move || s(bounds));
let boxed: Box<dyn Any + Send + Sync + 'static> = Box::new(boxed);
let sm = SurfaceMessage::Popup(
let sm = crate::surface::Action::Popup(
Arc::new(boxed),
Some({
let boxed: Box<
dyn Fn() -> crate::Element<
'static,
crate::app::Message<AppMessage>,
> + Send
dyn Fn() -> crate::Element<'static, Message>
+ Send
+ Sync
+ 'static,
> = Box::new(move || view());
@ -560,7 +534,7 @@ pub fn update<
Arc::new(boxed)
}),
);
shell.publish(sm.into());
shell.publish((on_surface_action)(sm));
}
}
}