pub struct MiniView { /* private fields */ }
Expand description
Provides the controls to show and consecutively close a miniview
window
For more, see show
.
Implementations§
source§impl MiniView
impl MiniView
sourcepub fn show(config: Config) -> MVResult<Self>
pub fn show(config: Config) -> MVResult<Self>
Create the controls to a new miniview
window
This will spawn a thread which will manage and create a graphical window. The
MiniView
struct on the main thread can be used to control the window.
The window can be closed explicitly by calling close
or we can wait until the user will
close the window manually by using wait_for_exit
instead.
When a MiniView
instance goes out of scope and is dropped, the thread managing the
graphical image view window will also die.
sourcepub fn close(self) -> MVResult<()>
pub fn close(self) -> MVResult<()>
Sends a ‘close window’ event to the thread managing the graphical window and waits for the thread to return
Compared to wait_for_exit
this method will explicitly attempt to close the window,
and should close almost instantly. This method blocks the until the window has been closed,
and the thread has been returned, or an error has been returned instead.
sourcepub fn wait_for_exit(self) -> MVResult<()>
pub fn wait_for_exit(self) -> MVResult<()>
Waits until the thread managing the graphical window returns
Compared to close
which attempts to instantaneously close the window regardless of user
input, this method will block and wait for the user to close the window.