pix-engine 0.8.0

A cross-platform graphics/UI engine framework for simple games, visualizations, and graphics demos.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

//! Operating System related methods.
//!
//! Provided [`PixState`] methods:
//!
//! - [`PixState::clipboard_text`]
//! - [`PixState::set_clipboard_text`]
//! - [`PixState::open_url`]
//!
//! # Example
//!
//! ```
//! # use pix_engine::prelude::*;
//! # struct App { text_entry: String };
//! # impl PixEngine for App {
//! fn on_update(&mut self, s: &mut PixState) -> PixResult<()> {
//!     if s.button("Open Homepage")? {
//!         s.open_url("https://example.com")?;
//!     }
//!     Ok(())
//! }
//!
//! fn on_key_pressed(&mut self, s: &mut PixState, event: KeyEvent) -> PixResult<bool> {
//!     match (event.keymod, event.key) {
//!         (KeyMod::CTRL, Key::C) => s.set_clipboard_text(&self.text_entry)?,
//!         (KeyMod::CTRL, Key::V) => self.text_entry = s.clipboard_text(),
//!         _ => (),
//!     }
//!     Ok(false)
//! }
//! # }
//! ```

use crate::{prelude::*, renderer::Rendering};

impl PixState {
    /// Get clipboard text from the system clipboard.
    ///
    /// # Example
    ///
    /// ```
    /// # use pix_engine::prelude::*;
    /// # struct App { checkbox: bool, text_field: String };
    /// # impl PixEngine for App {
    /// fn on_update(&mut self, s: &mut PixState) -> PixResult<()> {
    ///     println!("Current clipboard text: {}", s.clipboard_text());
    ///     Ok(())
    /// }
    /// # }
    /// ```
    #[inline]
    #[must_use]
    pub fn clipboard_text(&self) -> String {
        self.renderer.clipboard_text()
    }

    /// Set clipboard text to the system clipboard.
    ///
    /// # Errors
    ///
    /// If the renderer fails to retrieve the clipboard text, then an error is returned.
    ///
    /// # Example
    ///
    /// ```
    /// # use pix_engine::prelude::*;
    /// # struct App { checkbox: bool, text_field: String };
    /// # impl PixEngine for App {
    /// fn on_update(&mut self, s: &mut PixState) -> PixResult<()> {
    ///     s.set_clipboard_text("Copied to clipboard!")?;
    ///     Ok(())
    /// }
    /// # }
    /// ```
    #[inline]
    pub fn set_clipboard_text<S>(&self, value: S) -> PixResult<()>
    where
        S: AsRef<str>,
    {
        self.renderer.set_clipboard_text(value.as_ref())
    }

    /// Open a URL in the default system browser.
    ///
    /// # Errors
    ///
    /// If the renderer fails to launch an external application, then an error is returned. Note,
    /// there is no way to know if the URL opened successfully or not. An `Ok` result only means an
    /// application was successfully launched to handle the URL.
    ///
    /// # Example
    ///
    /// ```
    /// # use pix_engine::prelude::*;
    /// # struct App;
    /// # impl PixEngine for App {
    /// fn on_update(&mut self, s: &mut PixState) -> PixResult<()> {
    ///     if s.button("Open Homepage")? {
    ///         s.open_url("https://example.com")?;
    ///     }
    ///     Ok(())
    /// }
    /// # }
    /// ```
    #[inline]
    pub fn open_url<S>(&self, url: S) -> PixResult<()>
    where
        S: AsRef<str>,
    {
        self.renderer.open_url(url.as_ref())
    }
}