ferroui-diagnostics 0.4.0

The developer tools of FerroUI: the logical and visual trees, the properties and their value sources, routed events, the layout explorer and screenshots of a running application
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

//! Port of `DevToolsExtensions.cs`: the extension methods that attach DevTools to a top level
//! or an application.

use crate::diagnostics::{DevTools, DevToolsOptions};
use ferroui_base::input::KeyGesture;
use ferroui_controls::{Application, TopLevel};
use std::rc::Rc;

/// Extension methods for attaching DevTools..
///
/// Implemented by top levels (windows) and by the application.
pub trait DevToolsExtensions {
    /// Attaches DevTools, to be opened with the F12 key.
    fn attach_dev_tools(&self);

    /// Attaches DevTools, to be opened with the specified options.
    ///
    /// `options` are the additional settings of DevTools.
    ///
    /// For an application, attach DevTools should only be called after application
    /// initialization is complete. A good point is `on_framework_initialization_completed`:
    ///
    /// ```ignore
    /// impl ApplicationImpl for App {
    ///     fn on_framework_initialization_completed(this: &Self) {
    ///         // Create the main window of the lifetime of the application...
    ///         Self::parent_on_framework_initialization_completed(this);
    ///         this.attach_dev_tools_with_options(DevToolsOptions::new().with_startup_screen_index(Some(1)));
    ///     }
    /// }
    /// ```
    fn attach_dev_tools_with_options(&self, options: Rc<DevToolsOptions>);
}

/// The extension method of top levels for attaching DevTools with a key gesture (upstream has it
/// for top levels only).
pub trait DevToolsTopLevelExtensions {
    /// Attaches DevTools to a window, to be opened with the specified key gesture.
    ///
    /// `gesture` is the key gesture to open DevTools.
    fn attach_dev_tools_with_gesture(&self, gesture: KeyGesture);
}

impl DevToolsExtensions for TopLevel {
    /// Attaches DevTools to a window, to be opened with the F12 key.
    fn attach_dev_tools(&self) {
        DevTools::attach(self, DevToolsOptions::new());
    }

    /// Attaches DevTools to a window, to be opened with the specified options.
    fn attach_dev_tools_with_options(&self, options: Rc<DevToolsOptions>) {
        DevTools::attach(self, options);
    }
}

impl DevToolsTopLevelExtensions for TopLevel {
    fn attach_dev_tools_with_gesture(&self, gesture: KeyGesture) {
        DevTools::attach_with_gesture(self, gesture);
    }
}

impl DevToolsExtensions for Application {
    /// Attaches DevTools to an application, to be opened with the F12 key.
    fn attach_dev_tools(&self) {
        DevTools::attach_application(self, DevToolsOptions::new());
    }

    /// Attaches DevTools to an application, to be opened with the specified options.
    fn attach_dev_tools_with_options(&self, options: Rc<DevToolsOptions>) {
        DevTools::attach_application(self, options);
    }
}