leyoda/libcosmic
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

refactor: about page as a widget

Browse source
This commit is contained in:
Eduardo Flores 2024-11-10 02:42:16 +01:00 • committed by GitHub
parent 6f53b68be5
commit d8357d0ea3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 239 additions and 240 deletions
Download patch file Download diff file Expand all files Collapse all files

4
Cargo.toml
View file

@ -40,7 +40,7 @@ desktop = [
"process",
"dep:freedesktop-desktop-entry",
"dep:mime",
"dep:open",
"dep:license",
"dep:shlex",
"tokio?/io-util",
"tokio?/net",
@ -98,8 +98,8 @@ fraction = "0.15.3"
image = { version = "0.25.1", optional = true }
lazy_static = "1.4.0"
libc = { version = "0.2.155", optional = true }
license = { version = "3.5.1", optional = true }
mime = { version = "0.3.17", optional = true }
open = { version = "5.3.0", optional = true }
palette = "0.7.3"
rfd = { version = "0.14.0", optional = true }
rustix = { version = "0.38.34", features = [

1
examples/about/Cargo.toml
View file

@ -7,6 +7,7 @@ edition = "2021"
tracing = "0.1.37"
tracing-subscriber = "0.3.17"
tracing-log = "0.2.0"
open = "5.3.0"
[dependencies.libcosmic]
path = "../../"

42
examples/about/src/main.rs
View file

@ -3,10 +3,10 @@
//! Application API example
use cosmic::app::{about::About, Core, Settings, Task};
use cosmic::app::{Core, Settings, Task};
use cosmic::iced::widget::column;
use cosmic::iced_core::Size;
use cosmic::widget::{self, nav_bar};
use cosmic::widget::{self, about::About, nav_bar};
use cosmic::{executor, iced, ApplicationExt, Element};
/// Runs application with these settings
@ -27,7 +27,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
#[derive(Clone, Debug)]
pub enum Message {
ToggleAbout,
Cosmic(cosmic::app::cosmic::Message),
Open(String),
}
/// The [`App`] stores application-specific state.
@ -64,14 +64,17 @@ impl cosmic::Application for App {
let nav_model = nav_bar::Model::default();
let about = About::default()
.set_application_name("About Demo")
.set_application_icon(Self::APP_ID)
.set_developer_name("System 76")
.set_license_type("GPL-3.0")
.set_website("https://system76.com/cosmic")
.set_repository_url("https://github.com/pop-os/libcosmic")
.set_support_url("https://github.com/pop-os/libcosmic/issues")
.set_developers([("Michael Murphy".into(), "mmstick@system76.com".into())]);
.name("About Demo")
.icon(Self::APP_ID)
.version("0.1.0")
.author("System 76")
.license("GPL-3.0-only")
.developers([("Michael Murphy", "mmstick@system76.com")])
.links([
("Website", "https://system76.com/cosmic"),
("Repository", "https://github.com/pop-os/libcosmic"),
("Support", "https://github.com/pop-os/libcosmic/issues"),
]);
let mut app = App {
core,
@ -100,11 +103,7 @@ impl cosmic::Application for App {
return None;
}
if let Some(abuot_view) = self.about_view() {
Some(abuot_view.map(Message::Cosmic))
} else {
None
}
Some(widget::about(&self.about, Message::Open))
}
/// Handle application events here.
@ -114,17 +113,14 @@ impl cosmic::Application for App {
self.core.window.show_context = !self.core.window.show_context;
self.core.set_show_context(self.core.window.show_context)
}
Message::Cosmic(message) => {
return cosmic::command::message(cosmic::app::Message::Cosmic(message))
}
Message::Open(url) => match open::that_detached(url) {
Ok(_) => (),
Err(err) => tracing::error!("Failed to open URL: {err}"),
},
}
Task::none()
}
fn about(&self) -> Option<&About> {
Some(&self.about)
}
/// Creates a view after each update.
fn view(&self) -> Element<Self::Message> {
let centered = cosmic::widget::container(

119
src/app/about.rs
View file

@ -1,119 +0,0 @@
#[cfg(feature = "desktop")]
use std::collections::BTreeMap;
#[cfg(feature = "desktop")]
#[derive(Debug, Default, Clone, derive_setters::Setters)]
#[setters(prefix = "set_", into, strip_option)]
pub struct About {
/// The application's name.
pub application_name: Option<String>,
/// The application's icon name.
pub application_icon: Option<String>,
/// Artists who contributed to the application.
#[setters(skip)]
pub artists: BTreeMap<String, String>,
/// Comments about the application.
pub comments: Option<String>,
/// The application's copyright.
pub copyright: Option<String>,
/// Designers who contributed to the application.
#[setters(skip)]
pub designers: BTreeMap<String, String>,
/// Name of the application's developer.
pub developer_name: Option<String>,
/// Developers who contributed to the application.
#[setters(skip)]
pub developers: BTreeMap<String, String>,
/// Documenters who contributed to the application.
#[setters(skip)]
pub documenters: BTreeMap<String, String>,
/// The license text.
pub license: Option<String>,
/// The license from a list of known licenses.
pub license_type: Option<String>,
/// The URL of the application’s support page.
#[setters(skip)]
pub support_url: Option<String>,
/// The URL of the application’s repository.
#[setters(skip)]
pub repository_url: Option<String>,
/// Translators who contributed to the application.
#[setters(skip)]
pub translators: BTreeMap<String, String>,
/// Links associated with the application.
#[setters(skip)]
pub links: BTreeMap<String, String>,
/// The application’s version.
pub version: Option<String>,
/// The application’s website.
#[setters(skip)]
pub website: Option<String>,
}
impl About {
pub fn set_repository_url(mut self, repository_url: impl Into<String>) -> Self {
let repository_url = repository_url.into();
self.repository_url = Some(repository_url.clone());
self.links.insert("Repository".into(), repository_url);
self
}
pub fn set_support_url(mut self, support_url: impl Into<String>) -> Self {
let support_url = support_url.into();
self.support_url = Some(support_url.clone());
self.links.insert("Support".into(), support_url);
self
}
pub fn set_website(mut self, website: impl Into<String>) -> Self {
let website = website.into();
self.website = Some(website.clone());
self.links.insert("Website".into(), website);
self
}
pub fn set_artists(mut self, artists: impl Into<BTreeMap<String, String>>) -> Self {
let artists: BTreeMap<String, String> = artists.into();
self.artists = artists
.into_iter()
.map(|(k, v)| (k, format!("mailto:{v}")))
.collect();
self
}
pub fn set_designers(mut self, designers: impl Into<BTreeMap<String, String>>) -> Self {
let designers: BTreeMap<String, String> = designers.into();
self.designers = designers
.into_iter()
.map(|(k, v)| (k, format!("mailto:{v}")))
.collect();
self
}
pub fn set_developers(mut self, developers: impl Into<BTreeMap<String, String>>) -> Self {
let developers: BTreeMap<String, String> = developers.into();
self.developers = developers
.into_iter()
.map(|(k, v)| (k, format!("mailto:{v}")))
.collect();
self
}
pub fn set_documenters(mut self, documenters: impl Into<BTreeMap<String, String>>) -> Self {
let documenters: BTreeMap<String, String> = documenters.into();
self.documenters = documenters
.into_iter()
.map(|(k, v)| (k, format!("mailto:{v}")))
.collect();
self
}
pub fn set_translators(mut self, translators: impl Into<BTreeMap<String, String>>) -> Self {
let translators: BTreeMap<String, String> = translators.into();
self.translators = translators
.into_iter()
.map(|(k, v)| (k, format!("mailto:{v}")))
.collect();
self
}
}

8
src/app/cosmic.rs
View file

@ -78,9 +78,6 @@ pub enum Message {
/// Tracks updates to window suggested size.
#[cfg(feature = "applet")]
SuggestedBounds(Option<iced::Size>),
#[cfg(feature = "desktop")]
/// Opens the provided URL.
OpenUrl(String),
}
#[derive(Default)]
@ -664,11 +661,6 @@ impl<T: Application> Cosmic<T> {
let core = self.app.core_mut();
core.applet.suggested_bounds = b;
}
#[cfg(feature = "desktop")]
Message::OpenUrl(url) => match open::that_detached(url) {
Ok(_) => (),
Err(err) => tracing::error!("{err}"),
},
_ => {}
}

88
src/app/mod.rs
View file

@ -6,9 +6,6 @@
//! Check out our [application](https://github.com/pop-os/libcosmic/tree/master/examples/application)
//! example in our repository.
#[cfg(feature = "desktop")]
pub mod about;
pub mod command;
mod core;
pub mod cosmic;
@ -76,7 +73,6 @@ use {
#[cfg(feature = "desktop")]
use {
crate::app::about::About,
crate::widget,
iced::{alignment::Vertical, Alignment},
std::collections::BTreeMap,
@ -602,90 +598,6 @@ where
panic!("no view for window {id:?}");
}
#[cfg(feature = "desktop")]
/// Provides information about the application.
fn about(&self) -> Option<&About> {
None
}
#[cfg(feature = "desktop")]
/// Constructs the view for the about section.
fn about_view<'a>(&'a self) -> Option<Element<'a, crate::app::cosmic::Message>> {
let about = self.about()?;
let spacing = crate::theme::active().cosmic().spacing;
let section = |list: &'a BTreeMap<String, String>, title: &'a str| {
if list.is_empty() {
None
} else {
let developers: Vec<Element<crate::app::cosmic::Message>> = list
.into_iter()
.map(|(name, url)| {
widget::button::custom(
widget::row()
.push(widget::text(name))
.push(horizontal_space())
.push(crate::widget::icon::from_name("link-symbolic").icon())
.padding(spacing.space_xxs)
.align_y(Vertical::Center),
)
.class(crate::theme::Button::Text)
.on_press(crate::app::cosmic::Message::OpenUrl(url.clone()))
.width(Length::Fill)
.into()
})
.collect();
Some(widget::settings::section().title(title).extend(developers))
}
};
let application_name = about.application_name.as_ref().map(widget::text::title3);
let application_icon = about
.application_icon
.as_ref()
.map(|icon| crate::desktop::IconSource::Name(icon.clone()).as_cosmic_icon());
let links_section = section(&about.links, "Links");
let developers_section = section(&about.developers, "Developers");
let designers_section = section(&about.designers, "Designers");
let artists_section = section(&about.artists, "Artists");
let translators_section = section(&about.translators, "Translators");
let documenters_section = section(&about.documenters, "Documenters");
let developer_name = about.developer_name.as_ref().map(widget::text);
let version = about.version.as_ref().map(widget::button::standard);
let license = about.license_type.as_ref().map(widget::button::standard);
let copyright = about.copyright.as_ref().map(widget::text::body);
let comments = about.comments.as_ref().map(widget::text::body);
let about = widget::scrollable(
widget::column()
.push_maybe(application_icon)
.push_maybe(application_name)
.push_maybe(developer_name)
.push(
widget::row()
.push_maybe(version)
.push_maybe(license)
.spacing(spacing.space_xs),
)
.push_maybe(links_section)
.push_maybe(developers_section)
.push_maybe(designers_section)
.push_maybe(artists_section)
.push_maybe(translators_section)
.push_maybe(documenters_section)
.push_maybe(comments)
.push_maybe(copyright)
.align_x(Alignment::Center)
.spacing(spacing.space_xs)
.width(Length::Fill),
)
.into();
Some(about)
}
/// Overrides the default style for applications
fn style(&self) -> Option<iced_runtime::Appearance> {
None

211
src/widget/about.rs Normal file
View file

@ -0,0 +1,211 @@
#[cfg(feature = "desktop")]
use {
crate::{
iced::{alignment::Vertical, Alignment, Length},
widget::{self, horizontal_space},
Element,
},
license::License,
};
#[derive(Debug, Default, Clone, derive_setters::Setters)]
#[setters(into, strip_option)]
/// Information about the application.
pub struct About {
/// The application's name.
name: Option<String>,
/// The application's icon name.
icon: Option<String>,
/// The application’s version.
version: Option<String>,
/// Name of the application's author.
author: Option<String>,
/// Comments about the application.
comments: Option<String>,
/// The application's copyright.
copyright: Option<String>,
/// The license name.
license: Option<String>,
/// Artists who contributed to the application.
#[setters(skip)]
artists: Vec<(String, String)>,
/// Designers who contributed to the application.
#[setters(skip)]
designers: Vec<(String, String)>,
/// Developers who contributed to the application.
#[setters(skip)]
developers: Vec<(String, String)>,
/// Documenters who contributed to the application.
#[setters(skip)]
documenters: Vec<(String, String)>,
/// Translators who contributed to the application.
#[setters(skip)]
translators: Vec<(String, String)>,
/// Links associated with the application.
#[setters(skip)]
links: Vec<(String, String)>,
}
impl<'a> About {
/// Artists who contributed to the application.
pub fn artists(mut self, artists: impl Into<Vec<(&'a str, &'a str)>>) -> Self {
let artists: Vec<(&'a str, &'a str)> = artists.into();
self.artists = artists
.into_iter()
.map(|(k, v)| (k.to_string(), format!("mailto:{v}")))
.collect();
self
}
/// Designers who contributed to the application.
pub fn designers(mut self, designers: impl Into<Vec<(&'a str, &'a str)>>) -> Self {
let designers: Vec<(&'a str, &'a str)> = designers.into();
self.designers = designers
.into_iter()
.map(|(k, v)| (k.to_string(), format!("mailto:{v}")))
.collect();
self
}
/// Developers who contributed to the application.
pub fn developers(mut self, developers: impl Into<Vec<(&'a str, &'a str)>>) -> Self {
let developers: Vec<(&'a str, &'a str)> = developers.into();
self.developers = developers
.into_iter()
.map(|(k, v)| (k.to_string(), format!("mailto:{v}")))
.collect();
self
}
/// Documenters who contributed to the application.
pub fn documenters(mut self, documenters: impl Into<Vec<(&'a str, &'a str)>>) -> Self {
let documenters: Vec<(&'a str, &'a str)> = documenters.into();
self.documenters = documenters
.into_iter()
.map(|(k, v)| (k.to_string(), format!("mailto:{v}")))
.collect();
self
}
/// Translators who contributed to the application.
pub fn translators(mut self, translators: impl Into<Vec<(&'a str, &'a str)>>) -> Self {
let translators: Vec<(&'a str, &'a str)> = translators.into();
self.translators = translators
.into_iter()
.map(|(k, v)| (k.to_string(), format!("mailto:{v}")))
.collect();
self
}
/// Links associated with the application.
pub fn links<T: Into<String>>(mut self, links: impl Into<Vec<(T, &'a str)>>) -> Self {
let links: Vec<(T, &'a str)> = links.into();
self.links = links
.into_iter()
.map(|(k, v)| (k.into(), v.to_string()))
.collect();
self
}
fn license_url(&self) -> Option<String> {
let license: &dyn License = match self.license.as_ref() {
Some(license) => license.parse().ok()?,
None => return None,
};
self.license
.as_ref()
.map(|_| format!("https://spdx.org/licenses/{}.html", license.id()))
}
}
/// Constructs the widget for the about section.
pub fn about<'a, Message: Clone + 'static>(
about: &'a About,
on_url_press: impl Fn(String) -> Message,
) -> Element<'a, Message> {
let spacing = crate::theme::active().cosmic().spacing;
let section = |list: &'a Vec<(String, String)>, title: &'a str| {
(!list.is_empty()).then_some({
let developers: Vec<Element<Message>> =
list.iter()
.map(|(name, url)| {
widget::button::custom(
widget::row()
.push(widget::text(name))
.push(horizontal_space())
.push_maybe((!url.is_empty()).then_some(
crate::widget::icon::from_name("link-symbolic").icon(),
))
.padding(spacing.space_xxs)
.align_y(Vertical::Center),
)
.class(crate::theme::Button::Text)
.on_press(on_url_press(url.clone()))
.width(Length::Fill)
.into()
})
.collect();
widget::settings::section().title(title).extend(developers)
})
};
let application_name = about.name.as_ref().map(widget::text::title3);
let application_icon = about
.icon
.as_ref()
.map(|icon| crate::desktop::IconSource::Name(icon.clone()).as_cosmic_icon());
let links_section = section(&about.links, "Links");
let developers_section = section(&about.developers, "Developers");
let designers_section = section(&about.designers, "Designers");
let artists_section = section(&about.artists, "Artists");
let translators_section = section(&about.translators, "Translators");
let documenters_section = section(&about.documenters, "Documenters");
let author = about.author.as_ref().map(widget::text);
let version = about.version.as_ref().map(widget::button::standard);
let license = about.license.as_ref().map(|license| {
let url = about.license_url();
widget::settings::section().title("License").add(
widget::button::custom(
widget::row()
.push(widget::text(license))
.push(horizontal_space())
.push_maybe(
url.is_some()
.then_some(crate::widget::icon::from_name("link-symbolic").icon()),
)
.padding(spacing.space_xxs)
.align_y(Vertical::Center),
)
.class(crate::theme::Button::Text)
.on_press(on_url_press(url.unwrap_or(String::new())))
.width(Length::Fill),
)
});
let copyright = about.copyright.as_ref().map(widget::text::body);
let comments = about.comments.as_ref().map(widget::text::body);
widget::scrollable(
widget::column()
.push_maybe(application_icon)
.push_maybe(application_name)
.push_maybe(author)
.push_maybe(version)
.push_maybe(license)
.push_maybe(links_section)
.push_maybe(developers_section)
.push_maybe(designers_section)
.push_maybe(artists_section)
.push_maybe(translators_section)
.push_maybe(documenters_section)
.push_maybe(comments)
.push_maybe(copyright)
.align_x(Alignment::Center)
.spacing(spacing.space_xs)
.width(Length::Fill),
)
.spacing(spacing.space_xxxs)
.into()
}

6
src/widget/mod.rs
View file

@ -365,3 +365,9 @@ pub use warning::*;
#[cfg(feature = "markdown")]
#[doc(inline)]
pub use iced::widget::markdown;
#[cfg(feature = "desktop")]
pub mod about;
#[cfg(feature = "desktop")]
#[doc(inline)]
pub use about::about;