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

feat(dialog): XDG portal integrations for open and save dialogs

Browse source
This commit is contained in:
Michael Aaron Murphy 2023-08-15 10:58:46 +02:00 • committed by Michael Murphy
parent a5d3814fff
commit 1705b6fe27
10 changed files with 861 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

37
examples/application/src/main.rs
View file

@ -1,27 +1,46 @@
// Copyright 2023 System76 <info@system76.com>
// SPDX-License-Identifier: MPL-2.0
//! Testing ground for improving COSMIC application API ergonomics.
//! Application API example
use cosmic::app::{Command, Core, Settings};
use cosmic::widget::nav_bar;
use cosmic::{executor, iced, ApplicationExt, Element};
#[derive(Clone, Copy)]
pub enum Page {
Page1,
Page2,
Page3,
Page4,
}
impl Page {
const fn as_str(self) -> &'static str {
match self {
Page::Page1 => "Page 1",
Page::Page2 => "Page 2",
Page::Page3 => "Page 3",
Page::Page4 => "Page 4",
}
}
}
/// Runs application with these settings
#[rustfmt::skip]
fn main() -> Result<(), Box<dyn std::error::Error>> {
let input = vec![
("Page 1".into(), "🖖 Hello from libcosmic.".into()),
("Page 2".into(), "🌟 This is an example application.".into()),
("Page 3".into(), "🚧 The libcosmic API is not stable yet.".into()),
("Page 4".into(), "🚀 Copy the source code and experiment today!".into()),
(Page::Page1, "🖖 Hello from libcosmic.".into()),
(Page::Page2, "🌟 This is an example application.".into()),
(Page::Page3, "🚧 The libcosmic API is not stable yet.".into()),
(Page::Page4, "🚀 Copy the source code and experiment today!".into()),
];
let settings = Settings::default()
.antialiasing(true)
.client_decorations(true)
.debug(false)
.default_icon_theme("Pop")
.default_icon_theme(Some("Pop".into()))
.default_text_size(16.0)
.scale_factor(1.0)
.size((1024, 768))
@ -48,7 +67,7 @@ impl cosmic::Application for App {
type Executor = executor::Default;
/// Argument received [`cosmic::Application::new`].
type Flags = Vec<(String, String)>;
type Flags = Vec<(Page, String)>;
/// Message type specific to our [`App`].
type Message = Message;
@ -68,7 +87,7 @@ impl cosmic::Application for App {
let mut nav_model = nav_bar::Model::default();
for (title, content) in input {
nav_model.insert().text(title).data(content);
nav_model.insert().text(title.as_str()).data(content);
}
nav_model.activate_position(0);
@ -91,10 +110,12 @@ impl cosmic::Application for App {
self.update_title()
}
/// Handle application events here.
fn update(&mut self, _message: Self::Message) -> Command<Self::Message> {
Command::none()
}
/// Creates a view after each update.
fn view(&self) -> Element<Self::Message> {
let page_content = self
.nav_model

16
examples/open-dialog/Cargo.toml Normal file
View file

@ -0,0 +1,16 @@
[package]
name = "open_dialog"
version = "0.1.0"
edition = "2021"
[dependencies]
apply = "0.3.0"
tokio = { version = "1.31", features = ["full"] }
tracing = "0.1.37"
tracing-subscriber = "0.3.17"
url = "2.4.0"
[dependencies.libcosmic]
path = "../../"
default-features = false
features = ["debug", "wayland", "tokio", "xdg-portal"]

259
examples/open-dialog/src/main.rs Normal file
View file

@ -0,0 +1,259 @@
// Copyright 2023 System76 <info@system76.com>
// SPDX-License-Identifier: MPL-2.0
//! An application which provides an open dialog
use apply::Apply;
use cosmic::app::{Command, Core, Settings};
use cosmic::dialog::{open_file, FileFilter};
use cosmic::iced_core::Length;
use cosmic::{executor, iced, ApplicationExt, Element};
use tokio::io::AsyncReadExt;
use url::Url;
/// Runs application with these settings
#[rustfmt::skip]
fn main() -> Result<(), Box<dyn std::error::Error>> {
let settings = Settings::default()
.size((1024, 768));
cosmic::app::run::<App>(settings, ())?;
Ok(())
}
/// Messages that are used specifically by our [`App`].
#[derive(Clone, Debug)]
pub enum Message {
CloseError,
DialogClosed,
DialogInit(open_file::Sender),
DialogOpened,
Error(String),
FileRead(Url, String),
OpenFile,
Selected(Url),
}
/// The [`App`] stores application-specific state.
pub struct App {
core: Core,
open_sender: Option<open_file::Sender>,
file_contents: String,
selected_file: Option<Url>,
error_status: Option<String>,
}
/// Implement [`cosmic::Application`] to integrate with COSMIC.
impl cosmic::Application for App {
/// Default async executor to use with the app.
type Executor = executor::Default;
/// Argument received [`cosmic::Application::new`].
type Flags = ();
/// Message type specific to our [`App`].
type Message = Message;
const APP_ID: &'static str = "org.cosmic.OpenDialogDemo";
fn core(&self) -> &Core {
&self.core
}
fn core_mut(&mut self) -> &mut Core {
&mut self.core
}
/// Creates the application, and optionally emits command on initialize.
fn init(core: Core, _input: Self::Flags) -> (Self, Command<Self::Message>) {
let mut app = App {
core,
open_sender: None,
file_contents: String::new(),
selected_file: None,
error_status: None,
};
let command = app.set_title("Open a file".into());
(app, command)
}
fn header_end(&self) -> Vec<Element<Self::Message>> {
// Places a button the header to create open dialogs.
vec![cosmic::widget::button(cosmic::theme::Button::Primary)
.text("Open")
.on_press(Message::OpenFile)
.into()]
}
fn subscription(&self) -> cosmic::iced_futures::Subscription<Self::Message> {
// Creates a subscription for handling open dialogs.
open_file::subscription(|response| match response {
open_file::Message::Closed => Message::DialogClosed,
open_file::Message::Opened => Message::DialogOpened,
open_file::Message::Selected(files) => match files.uris().first() {
Some(file) => Message::Selected(file.to_owned()),
None => Message::DialogClosed,
},
open_file::Message::Init(sender) => Message::DialogInit(sender),
open_file::Message::Err(why) => {
let mut source: &dyn std::error::Error = &why;
let mut string = format!("open dialog subscription errored\n cause: {source}");
while let Some(new_source) = source.source() {
string.push_str(&format!("\n cause: {new_source}"));
source = new_source;
}
Message::Error(string)
}
})
}
fn update(&mut self, message: Self::Message) -> Command<Self::Message> {
match message {
Message::DialogClosed => {
eprintln!("dialog closed");
}
Message::DialogOpened => {
if let Some(sender) = self.open_sender.as_mut() {
eprintln!("requesting selection");
return sender.response().map(|_| cosmic::app::Message::None);
}
}
Message::FileRead(url, contents) => {
eprintln!("read file");
self.selected_file = Some(url);
self.file_contents = contents;
}
Message::Selected(url) => {
eprintln!("selected file");
// Take existing file contents buffer to reuse its allocation.
let mut contents = String::new();
std::mem::swap(&mut contents, &mut self.file_contents);
return Command::batch(vec![
// Set the file's URL as the application title.
self.set_title(url.to_string()),
// Reads the selected file into memory.
cosmic::command::future(async move {
// Check if its a valid local file path.
let path = match url.scheme() {
"file" => url.path(),
other => {
return Message::Error(format!(
"{url} has unknown scheme: {other}"
));
}
};
// Open the file by its path.
let mut file = match tokio::fs::File::open(path).await {
Ok(file) => file,
Err(why) => {
return Message::Error(format!("failed to open {path}: {why}"));
}
};
// Read the file into our contents buffer.
contents.clear();
if let Err(why) = file.read_to_string(&mut contents).await {
return Message::Error(format!("failed to read {path}: {why}"));
}
contents.shrink_to_fit();
// Send this back to the application.
Message::FileRead(url, contents)
})
.map(cosmic::app::message::app),
]);
}
// Creates a new open dialog.
Message::OpenFile => {
if let Some(sender) = self.open_sender.as_mut() {
if let Some(dialog) = open_file::builder() {
eprintln!("opening new dialog");
return dialog
// Sets title of the dialog window.
.title("Choose a file".into())
// Sets the label of the accept button.
.accept_label("_Open".into())
// Exclude directories from file selection.
.include_directories(false)
// Defines whether to block the main window while requesting input.
.modal(false)
// Only accept one file as input.
.multiple_files(false)
// Accept only plain text files
.filter(FileFilter::new("Text files").mimetype("text/plain"))
// Emits the dialog to our sender
.create(sender)
// Ignores the output because it's empty.
.map(|_| cosmic::app::message::none());
}
}
}
// Displays an error in the application's warning bar.
Message::Error(why) => {
self.error_status = Some(why);
}
// Closes the warning bar, if it was shown.
Message::CloseError => {
self.error_status = None;
}
// The open dialog. subscription provides this on register.
Message::DialogInit(sender) => {
eprintln!("dialog subscription enabled");
self.open_sender = Some(sender);
}
}
Command::none()
}
fn view(&self) -> Element<Self::Message> {
let mut content = Vec::new();
if let Some(error) = self.error_status.as_deref() {
content.push(
cosmic::widget::warning(error)
.on_close(Message::CloseError)
.into(),
);
content.push(iced::widget::vertical_space(Length::Fixed(12.0)).into())
}
content.push(if self.selected_file.is_none() {
center(iced::widget::text("Choose a text file"))
} else {
cosmic::widget::text(&self.file_contents)
.apply(iced::widget::scrollable)
.width(iced::Length::Fill)
.into()
});
iced::widget::column(content).into()
}
}
fn center<'a>(input: impl Into<Element<'a, Message>> + 'a) -> Element<'a, Message> {
iced::widget::container(input.into())
.width(iced::Length::Fill)
.height(iced::Length::Fill)
.align_x(iced::alignment::Horizontal::Center)
.align_y(iced::alignment::Vertical::Center)
.into()
}