Struct renga_api_rs::Application

pub struct Application { /* private fields */ }

Represents entire Renga application.

Currently, you can obtain instance of this struct only by using Application::new or Application::new_hidden methods. Accessing running instances of Renga is still in development.

See Official documentation

Implementations

impl Application

pub fn new() -> Result<Self>

Creates new instance of Renga application¹.

See Application::new_hidden

./RengaProfessional.exe /regserver

If your Renga distribution comes from official installer, you can skip this step - Renga will be automatically registered.

---

1. Renga must be registered in Windows registry for this method to work. You can do it by launching powershell as administrator in Renga folder and running the following command: ↩

pub fn new_hidden() -> Result<Self>

Creates new headless instance of Renga application.

The ability to launch Renga without a GUI is advantageous for testing purposes. Actually, this crate using this feature for self-testing!

See Application::new

pub fn try_quit(&mut self) -> Result<()>

Tries to close Renga application.

See Application::quit

pub fn quit(&mut self)

Closes Renga application.

This method will not fail. If any error occurs, it will be logged.

See Application::try_quit

pub fn version(&self) -> Result<Version>

Returns semantic version of Renga application.

pub fn enabled(&self) -> Result<bool>

Returns true, if user input is enabled in this instance.

See Application::set_enabled

pub fn visible(&self) -> Result<bool>

Returns true, if user interface is visible in this instance.

See Application::set_visible

pub fn set_enabled(&mut self, value: bool) -> Result<&mut Self>

Sets user input to be enabled or disabled in this instance.

See Application::enabled

pub fn set_visible(&mut self, value: bool) -> Result<&mut Self>

Sets user interface to be visible or hidden in this instance.

See Application::visible

pub fn project(&mut self) -> Result<Option<Project>>

Returns currently active project.

Can be None if there is no active project opened.

You can create new project by calling Application::new_project or open existing project by calling Application::open_project.

pub fn new_project(&mut self) -> Result<Project>

Creates new project.

Can return error in the following cases:

• crate::Error::AlreadyOpened: Project is already opened;
• crate::Error::Internal: Internal error happened;

See Application::open_project

pub fn open_project(&mut self, path: &Path) -> Result<Project>

Opens existing project from given path.

Can return error in the following cases:

• crate::Error::NonexistentPath: Project path is invalid;
• crate::Error::AlreadyOpened: Project is already opened;
• crate::Error::Internal: Internal error happened;

See Application::new_project

pub fn native_window_handle(&self) -> Result<HWND>

Returns native handle of the main window.

Trait Implementations

impl Debug for Application

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for Application

Drop implementation for Application.

• Closes project if it exists, discarding any changes.
• Closes Renga application.

This function never fails or panics. If any error occurs, it will be logged.

fn drop(&mut self)

Executes the destructor for this type.