cosmic-workspaces/src/view/mod.rs
Ian Douglas Scott 04edd3b909 Add margins for auto-hide panels without exclusive zones
Works alongside panel changes in
https://github.com/pop-os/cosmic-panel/pull/485.

We can't set an exclusive zone in the panel, since that would cause all
the workspaces to re-layout to make space for it, and also impact
workspace capture. Instead, cosmic-workspaces reads the config and adds
appropriate margins.
2025-11-13 16:27:28 -08:00

643 lines
22 KiB
Rust

use cosmic::{
Apply,
cctk::{
cosmic_protocols::{
toplevel_info::v1::client::zcosmic_toplevel_handle_v1,
workspace::v2::client::zcosmic_workspace_handle_v2,
},
wayland_client::protocol::wl_output,
wayland_protocols::ext::workspace::v1::client::ext_workspace_handle_v1,
},
iced::{
self, Alignment, Border, Length,
advanced::layout::flex::Axis,
clipboard::mime::{AllowedMimeTypes, AsMimeTypes},
widget::{column, row},
},
iced_core::{Shadow, text::Wrapping},
iced_winit::platform_specific::wayland::subsurface_widget::Subsurface,
widget::{self, Widget},
};
use cosmic_comp_config::workspace::WorkspaceLayout;
use std::collections::{HashMap, HashSet};
use crate::{
App, LayerSurface, Msg, Toplevel, Workspace,
backend::{self, CaptureImage},
dnd::{Drag, DragSurface, DragToplevel, DragWorkspace, DropTarget},
};
fn dnd_source_with_drag_surface<D: AsMimeTypes + Send + Clone + 'static>(
drag_content: D,
drag_surface: DragSurface,
id: Option<iced::id::Id>,
child: cosmic::Element<'_, Msg>,
drag_icon: impl Fn() -> cosmic::Element<'static, Msg> + 'static,
) -> cosmic::Element<'_, Msg> {
let mut source = cosmic::widget::dnd_source(child)
.drag_threshold(5.)
.drag_content(move || drag_content.clone())
.drag_icon(move |offset| {
(
drag_icon().map(|_| ()),
cosmic::iced_core::widget::tree::State::None,
-offset,
)
})
.on_start(Some(Msg::StartDrag(drag_surface)))
.on_finish(Some(Msg::SourceFinished))
.on_cancel(Some(Msg::SourceFinished));
if let Some(id) = id {
source.set_id(id);
}
source.into()
}
fn dnd_destination_for_target<T>(
target: DropTarget,
child: cosmic::Element<'_, Msg>,
on_finish: impl Fn(T) -> Msg + 'static,
) -> cosmic::Element<'_, Msg>
where
T: AllowedMimeTypes,
{
let target2 = target.clone();
cosmic::widget::dnd_destination::dnd_destination_for_data(
child,
move |data: Option<T>, _action| match data {
Some(data) => on_finish(data),
None => Msg::Ignore,
},
)
.drag_id(target.drag_id())
.on_enter(move |actions, mime, pos| Msg::DndEnter(target.clone(), actions, mime, pos))
.on_leave(move || Msg::DndLeave(target2.clone()))
.into()
}
pub(crate) fn layer_surface<'a>(
app: &'a App,
surface: &'a LayerSurface,
) -> cosmic::Element<'a, Msg> {
let mut drag_toplevel = None;
let mut drag_workspace = None;
match &app.drag_surface {
Some((DragSurface::Toplevel(handle), _)) => {
drag_toplevel = Some(handle);
}
Some((DragSurface::Workspace(handle), _)) => {
drag_workspace = Some(handle);
}
_ => {}
}
#[allow(clippy::mutable_key_type)]
let workspaces_with_toplevels = app
.toplevels
.0
.iter()
.flat_map(|t| &t.info.workspace)
.collect::<HashSet<_>>();
let layout = app.conf.workspace_config.workspace_layout;
let sidebar = workspaces_sidebar(
app.workspaces.for_output(&surface.output),
&workspaces_with_toplevels,
&surface.output,
layout,
app.drop_target.as_ref(),
drag_workspace,
);
let toplevels = toplevel_previews(
app.toplevels.0.iter().filter(|i| {
if !i.info.output.contains(&surface.output) {
return false;
}
i.info.workspace.iter().any(|workspace| {
app.workspaces
.for_handle(workspace)
.is_some_and(|x| x.is_active())
})
}),
layout,
drag_toplevel,
);
// TODO multiple active workspaces? Not currently supported by cosmic.
let first_active_workspace = app
.workspaces
.for_output(&surface.output)
.find(|w| w.is_active());
let toplevels = if let Some(workspace) = first_active_workspace {
dnd_destination_for_target(
DropTarget::OutputToplevels(workspace.handle().clone(), surface.output.clone()),
toplevels,
Msg::DndToplevelDrop,
)
} else {
// Shouldn't happen, but no drag destination if no active workspace found for output
cosmic::Element::from(toplevels)
};
let container = match layout {
WorkspaceLayout::Vertical => widget::layer_container(
row![sidebar, toplevels]
.spacing(12)
.height(Length::Fill)
.width(Length::Fill),
),
WorkspaceLayout::Horizontal => widget::layer_container(
column![sidebar, toplevels]
.spacing(12)
.height(Length::Fill)
.width(Length::Fill),
),
};
let panel_regions = app.panel_regions(&surface.output);
let container = widget::container(container).padding(panel_regions);
let output = surface.output.clone();
widget::mouse_area(container)
.on_scroll(move |delta| Msg::OnScroll(output.clone(), delta))
.into()
}
fn close_button(on_press: Msg) -> cosmic::Element<'static, Msg> {
widget::button::custom(widget::icon::from_name("window-close-symbolic").size(16))
.class(cosmic::theme::Button::Destructive)
.on_press(on_press)
.into()
}
fn pin_button_style(theme: &cosmic::Theme, is_pinned: bool) -> cosmic::widget::button::Style {
let bg_color = if is_pinned {
theme.cosmic().accent.base.into()
} else {
theme.cosmic().primary.base.into()
};
let icon_color = if is_pinned {
theme.cosmic().accent.on.into()
} else {
theme.cosmic().primary.on.into()
};
cosmic::widget::button::Style {
icon_color: Some(icon_color),
background: Some(iced::Background::Color(bg_color)),
border_radius: theme.cosmic().corner_radii.radius_m.into(),
..cosmic::widget::button::Style::new()
}
}
fn pin_button(workspace: &Workspace) -> cosmic::Element<'static, Msg> {
let is_pinned = workspace.is_pinned();
crate::widgets::visibility_wrapper(
widget::button::custom(
widget::icon::from_name("pin-symbolic")
.symbolic(true)
.size(16), //.style(|theme, status| todo!())
)
.padding([4, 8])
//.class(cosmic::theme::Button::Icon)
//.class(cosmic::theme::Button::Image)
.class(cosmic::theme::Button::Custom {
// TODO adjust state for hover, etc.
active: Box::new(move |_, theme| pin_button_style(theme, is_pinned)),
disabled: Box::new(move |theme| pin_button_style(theme, is_pinned)),
hovered: Box::new(move |_, theme| pin_button_style(theme, is_pinned)),
pressed: Box::new(move |_, theme| pin_button_style(theme, is_pinned)),
})
//.class(cosmic::theme::Button::Standard)
// TODO style selected correctly
.selected(workspace.is_pinned())
.on_press(Msg::TogglePinned(workspace.handle().clone())),
// Show pin button only if hovered or pinned; but allocate space the same way
// regardless
(workspace.has_cursor || workspace.is_pinned())
&& workspace
.info
.cosmic_capabilities
.contains(zcosmic_workspace_handle_v2::WorkspaceCapabilities::Pin),
)
.into()
}
fn workspace_item_appearance(
theme: &cosmic::Theme,
is_active: bool,
hovered: bool,
) -> cosmic::widget::button::Style {
let cosmic = theme.cosmic();
let mut appearance = cosmic::widget::button::Style::new();
appearance.border_radius = cosmic
.corner_radii
.radius_s
.map(|x| if x < 4.0 { x } else { x + 4.0 })
.into();
if is_active {
appearance.border_width = 4.0;
appearance.border_color = cosmic.accent.base.into();
}
if hovered {
appearance.background = Some(iced::Background::Color(cosmic.button.base.into()));
}
appearance
}
fn workspace_item(
workspace: &Workspace,
_output: &wl_output::WlOutput,
layout: WorkspaceLayout,
is_drop_target: bool,
has_workspace_drag: bool,
) -> cosmic::Element<'static, Msg> {
let (mut image, image_height, image_width) = if let Some(img) = workspace.img.as_ref() {
let is_rotated = matches!(
img.transform,
wl_output::Transform::_90
| wl_output::Transform::_270
| wl_output::Transform::Flipped90
| wl_output::Transform::Flipped270
);
let (effective_width, effective_height) = if is_rotated {
// If rotated, swap width and height
(img.height, img.width)
} else {
(img.width, img.height)
};
if effective_width > effective_height {
(
// Landscape: fix height
widget::container(capture_image(Some(img), 1.0)).max_height(126.0),
126.0,
126.0 * effective_width as f32 / effective_height as f32,
)
} else {
(
// Portrait: fix width
widget::container(capture_image(Some(img), 1.0)).max_width(160),
160.0 * effective_height as f32 / effective_width as f32,
160.0,
)
}
} else {
(
widget::container(capture_image(None, 1.0))
.max_height(126.0)
.max_width(224.0),
126.0,
224.0,
)
};
let workspace_footer = row![
widget::horizontal_space().width(Length::Fixed(32.0)),
widget::text::body(fl!(
"workspace",
HashMap::from([("number", &workspace.info.name)])
))
.apply(widget::container)
.center_x(Length::Fill),
pin_button(workspace),
];
// Needed to prevent footer content getting pushed out when scaling on Vertical layout
if layout == WorkspaceLayout::Vertical {
image = image.height(Length::Fill);
}
let content = column![image, workspace_footer]
.spacing(4)
.align_x(Alignment::Center)
.apply(widget::container)
.max_height(image_height + 28.0)
.max_width(image_width);
let is_active = workspace.is_active() && !has_workspace_drag;
// TODO editable name?
let mut button = widget::button::custom(content)
.selected(is_active)
.class(cosmic::theme::Button::Custom {
active: Box::new(move |_focused, theme| {
workspace_item_appearance(theme, is_active, is_drop_target)
}),
disabled: Box::new(move |theme| {
workspace_item_appearance(theme, is_active, is_drop_target)
}),
hovered: Box::new(move |_focused, theme| {
workspace_item_appearance(theme, is_active, true)
}),
pressed: Box::new(move |_focused, theme| {
workspace_item_appearance(theme, is_active, true)
}),
})
.padding(8);
if workspace
.info
.capabilities
.contains(ext_workspace_handle_v1::WorkspaceCapabilities::Activate)
{
button = button.on_press(Msg::ActivateWorkspace(workspace.handle().clone()));
}
button.into()
}
fn workspace_drag_placeholder(
other_workspace: &Workspace,
other_output: &wl_output::WlOutput,
layout: WorkspaceLayout,
) -> cosmic::Element<'static, Msg> {
let drop_target = DropTarget::WorkspaceSidebarDragPlaceholder(
other_workspace.handle().clone(),
other_output.clone(),
);
let placeholder = widget::button::custom(widget::Space::new(Length::Fill, Length::Fill))
.class(cosmic::theme::Button::Custom {
active: Box::new(|_, _| unreachable!()),
disabled: Box::new(|theme| workspace_item_appearance(theme, true, true)),
hovered: Box::new(|_, _| unreachable!()),
pressed: Box::new(|_, _| unreachable!()),
})
.padding(8);
let placeholder = crate::widgets::match_size(
workspace_item(other_workspace, other_output, layout, true, true),
placeholder,
);
dnd_destination_for_target(drop_target, placeholder.into(), Msg::DndWorkspaceDrop)
}
fn workspace_sidebar_entry<'a>(
workspace: &'a Workspace,
output: &'a wl_output::WlOutput,
layout: WorkspaceLayout,
is_drop_target: bool,
has_toplevels: bool,
has_workspace_drag: bool,
) -> cosmic::Element<'a, Msg> {
/* XXX
let mouse_interaction = if is_drop_target {
iced::mouse::Interaction::Crosshair
} else {
iced::mouse::Interaction::Idle
};
*/
let item = workspace_item(
workspace,
output,
layout,
is_drop_target,
has_workspace_drag,
);
let item = iced::widget::mouse_area(item)
.on_enter(Msg::EnteredWorkspaceSidebarEntry(
workspace.handle().clone(),
true,
))
.on_exit(Msg::EnteredWorkspaceSidebarEntry(
workspace.handle().clone(),
false,
));
let workspace_clone = workspace.clone(); // TODO avoid clone
let output_clone = output.clone();
let drop_target = DropTarget::WorkspaceSidebarEntry(workspace.handle().clone(), output.clone());
let destination =
dnd_destination_for_target(drop_target, item.into(), |drag: Drag| match drag {
Drag::Toplevel => Msg::DndToplevelDrop(DragToplevel {}),
Drag::Workspace => Msg::DndWorkspaceDrop(DragWorkspace {}),
});
// Cosmic-comp auto-removes workspaces that aren't pinned and don't have toplevels when they
// aren't the last workspace. So it shouldn't be possible to drag.
if (has_toplevels || workspace.is_pinned())
&& workspace
.info
.cosmic_capabilities
.contains(zcosmic_workspace_handle_v2::WorkspaceCapabilities::Move)
{
dnd_source_with_drag_surface(
DragWorkspace {},
DragSurface::Workspace(workspace.handle().clone()),
Some(workspace.dnd_source_id.clone()),
destination,
move || workspace_item(&workspace_clone, &output_clone, layout, false, true),
)
} else {
destination
}
}
#[allow(clippy::mutable_key_type)]
fn workspaces_sidebar<'a>(
workspaces: impl Iterator<Item = &'a Workspace>,
workspaces_with_toplevels: &HashSet<&backend::ExtWorkspaceHandleV1>,
output: &'a wl_output::WlOutput,
layout: WorkspaceLayout,
drop_target: Option<&DropTarget>,
drag_workspace: Option<&'a backend::ExtWorkspaceHandleV1>,
) -> cosmic::Element<'a, Msg> {
let mut sidebar_entries = Vec::new();
for workspace in workspaces {
// XXX Need dnd source with same id for drag to work; but give it 0x0 size
if drag_workspace == Some(workspace.handle()) {
let workspace_clone = workspace.clone();
let output_clone = output.clone();
let source = dnd_source_with_drag_surface(
DragWorkspace {},
DragSurface::Workspace(workspace.handle().clone()),
Some(workspace.dnd_source_id.clone()),
widget::Space::new(Length::Shrink, Length::Shrink).into(),
move || workspace_item(&workspace_clone, &output_clone, layout, false, true),
);
sidebar_entries.push(source);
continue;
}
let mut drop_target_is_workspace = false;
let mut drop_target_is_placeholder = false;
match drop_target {
Some(DropTarget::WorkspaceSidebarEntry(w, o))
if (w, o) == (workspace.handle(), output) =>
{
drop_target_is_workspace = true;
}
Some(DropTarget::WorkspaceSidebarDragPlaceholder(w, o))
if (w, o) == (workspace.handle(), output) =>
{
drop_target_is_placeholder = true;
}
_ => {}
}
if drag_workspace.is_some()
&& drag_workspace != Some(workspace.handle())
&& (drop_target_is_workspace || drop_target_is_placeholder)
{
sidebar_entries.push(workspace_drag_placeholder(workspace, output, layout));
}
sidebar_entries.push(workspace_sidebar_entry(
workspace,
output,
layout,
drop_target_is_workspace && drag_workspace.is_none(),
workspaces_with_toplevels.contains(workspace.handle()),
drag_workspace.is_some(),
));
}
let (axis, width, height) = match layout {
WorkspaceLayout::Vertical => (Axis::Vertical, Length::Shrink, Length::Fill),
WorkspaceLayout::Horizontal => (Axis::Horizontal, Length::Fill, Length::Shrink),
};
let sidebar_entries_container =
widget::container(crate::widgets::workspace_bar(sidebar_entries, axis)).padding(8.0);
widget::container(
widget::container(sidebar_entries_container)
.width(width)
.height(height)
.class(cosmic::theme::Container::custom(|theme| {
cosmic::iced::widget::container::Style {
text_color: Some(theme.cosmic().on_bg_color().into()),
icon_color: Some(theme.cosmic().on_bg_color().into()),
background: Some(iced::Color::from(theme.cosmic().background.base).into()),
border: Border {
radius: theme
.cosmic()
.radius_s()
.map(|x| if x < 4.0 { x } else { x + 8.0 })
.into(),
..Default::default()
},
shadow: Shadow::default(),
}
})),
)
.padding(8)
.into()
}
fn toplevel_preview(toplevel: &Toplevel, is_being_dragged: bool) -> cosmic::Element<'static, Msg> {
let cosmic::cosmic_theme::Spacing {
space_xxs, space_s, ..
} = cosmic::theme::active().cosmic().spacing;
let label = widget::text::body(toplevel.info.title.clone()).wrapping(Wrapping::None);
let label = if let Some(icon) = &toplevel.icon {
row![
widget::icon(widget::icon::from_path(icon.clone())).size(24),
label
]
.spacing(4)
} else {
row![label]
}
.align_y(Alignment::Center);
let alpha = if is_being_dragged { 0.5 } else { 1.0 };
crate::widgets::size_cross_nth(
vec![
row![
widget::button::custom(label)
.on_press(Msg::ActivateToplevel(toplevel.handle.clone()))
.class(cosmic::theme::Button::Icon)
.padding([space_xxs, space_s])
.apply(widget::container)
.class(cosmic::theme::Container::custom(|theme| {
cosmic::iced::widget::container::Style {
background: Some(
iced::Color::from(theme.cosmic().background.component.base).into(),
),
border: Border {
color: theme.cosmic().bg_divider().into(),
width: 1.0,
radius: theme.cosmic().radius_xl().into(),
},
..Default::default()
}
}))
.apply(widget::container)
.width(Length::FillPortion(5)),
widget::horizontal_space().width(Length::Fixed(8.0)),
close_button(Msg::CloseToplevel(toplevel.handle.clone()))
]
.padding([0, 0, 4, 0])
.align_y(Alignment::Center)
.into(),
widget::button::custom(capture_image(toplevel.img.as_ref(), alpha))
.selected(
toplevel
.info
.state
.contains(&zcosmic_toplevel_handle_v1::State::Activated),
)
.class(cosmic::theme::Button::Image)
.on_press(Msg::ActivateToplevel(toplevel.handle.clone()))
.into(),
],
Axis::Vertical,
1, // Allocate width to match capture image
)
//.spacing(4)
//.align_items(Alignment::Center)
//.width(Length::Fill)
.into()
}
fn toplevel_previews_entry(
toplevel: &Toplevel,
is_being_dragged: bool,
) -> cosmic::Element<'_, Msg> {
// Dragged window still takes up space until moved, but isn't rendered while drag surface is
// shown.
let preview = crate::widgets::visibility_wrapper(
toplevel_preview(toplevel, is_being_dragged),
!is_being_dragged,
);
let toplevel2 = toplevel.clone();
dnd_source_with_drag_surface(
DragToplevel {},
DragSurface::Toplevel(toplevel.handle.clone()),
None,
preview.into(),
move || toplevel_preview(&toplevel2, true),
)
}
fn toplevel_previews<'a>(
toplevels: impl Iterator<Item = &'a Toplevel>,
layout: WorkspaceLayout,
drag_toplevel: Option<&'a backend::ExtForeignToplevelHandleV1>,
) -> cosmic::Element<'a, Msg> {
let (width, height) = match layout {
WorkspaceLayout::Vertical => (Length::FillPortion(4), Length::Fill),
WorkspaceLayout::Horizontal => (Length::Fill, Length::FillPortion(4)),
};
let entries = toplevels
.map(|t| toplevel_previews_entry(t, drag_toplevel == Some(&t.handle)))
.collect();
//row(entries)
widget::mouse_area(
widget::container(crate::widgets::toplevels(entries))
.align_x(Alignment::Center)
.width(width)
.height(height)
//.spacing(16)
.padding(12),
)
.on_press(Msg::Close)
//.align_items(Alignment::Center)
.into()
}
fn capture_image(image: Option<&CaptureImage>, alpha: f32) -> cosmic::Element<'static, Msg> {
if let Some(image) = image {
#[cfg(feature = "no-subsurfaces")]
{
// TODO alpha, transform
widget::Image::new(image.image.clone()).into()
}
#[cfg(not(feature = "no-subsurfaces"))]
{
Subsurface::new(image.wl_buffer.clone())
.alpha(alpha)
.transform(image.transform)
.into()
}
} else {
widget::Image::new(widget::image::Handle::from_rgba(1, 1, vec![0, 0, 0, 255])).into()
}
}