DISTRHO Plugin Framework
 All Classes Functions Variables Modules Pages
Public Member Functions | Friends | List of all members
App Class Reference

#include <App.hpp>

Inheritance diagram for App:
StandaloneWindow

Public Member Functions

 App ()
 
 ~App ()
 
void idle ()
 
void exec ()
 
void quit ()
 
bool isQuiting () const noexcept
 

Friends

class Window
 

Detailed Description

Base DGL Application class.

One application instance is required for creating a window. There's no single/global application instance in DGL, and multiple windows can share the same app instance.

In standalone mode an application will automatically quit its event-loop when all its windows are closed.

Constructor & Destructor Documentation

App::App ( )

Constructor.

App::~App ( )

Destructor.

Member Function Documentation

void App::idle ( )

Idle function. This runs the application event-loop once.

void App::exec ( )

Run the application event-loop until all Windows are closed. idle() is called at regular intervals.

Note
: This function is meant for standalones only, never call this from plugins.
void App::quit ( )

Quit the application. This stops the event-loop and closes all Windows.

bool App::isQuiting ( ) const
noexcept

Check if the application is about to quit. Returning true means there's no event-loop running at the moment (or it's just about to stop).


The documentation for this class was generated from the following file: