Ubuntu Platform API  3.0.0
A library helping with tight integration into the Ubuntu platform
instance.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2013 Canonical Ltd.
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License version 3 as
6  * published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU Lesser General Public License for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * Authored by: Ricardo Mendoza <ricardo.mendoza@canonical.com>
17  * Thomas Voß <thomas.voss@canonical.com>
18  */
19 
20 #ifndef UBUNTU_APPLICATION_INSTANCE_H_
21 #define UBUNTU_APPLICATION_INSTANCE_H_
22 
23 #include <ubuntu/visibility.h>
24 
27 
28 #include <mir_toolkit/mir_client_library.h>
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
41  typedef void UApplicationInstance;
42 
50  UBUNTU_DLL_PUBLIC UApplicationInstance*
53  UApplicationOptions *options);
54 
63  UBUNTU_DLL_PUBLIC MirConnection*
65  UApplicationInstance *instance);
66 
67 
75  UApplicationInstance *instance);
76 
84  UApplicationInstance *instance);
85 
93  UApplicationInstance *instance);
94 
100  UBUNTU_DLL_PUBLIC void
102  UApplicationInstance *instance);
103 
104 #ifdef __cplusplus
105 }
106 #endif
107 
108 #endif /* UBUNTU_APPLICATION_INSTANCE_H_ */
UBUNTU_DLL_PUBLIC void u_application_instance_run(UApplicationInstance *instance)
Executes the event loop of the application instance.
UBUNTU_DLL_PUBLIC void u_application_instance_unref(UApplicationInstance *instance)
Decrements the reference count of an application instance and releases all resources held by the obje...
UBUNTU_DLL_PUBLIC UApplicationInstance * u_application_instance_new_from_description_with_options(UApplicationDescription *desc, UApplicationOptions *options)
Creates a new application instance with a reference count of 1.
UBUNTU_DLL_PUBLIC MirConnection * u_application_instance_get_mir_connection(UApplicationInstance *instance)
Return the MirConnection associated with an application instance. Use of MirConnection with the mir c...
UBUNTU_DLL_PUBLIC void u_application_instance_destroy(UApplicationInstance *instance)
Destroys the application instance and releases all its resources.
UBUNTU_DLL_PUBLIC void u_application_instance_ref(UApplicationInstance *instance)
Increments the reference count of an application instance.
void UApplicationDescription
Encapsulates properties of an application instance.
Definition: description.h:36
void UApplicationInstance
Opaque type describing an application instance.An application instance encapsulates the event loop of...
Definition: instance.h:41
void UApplicationOptions
Encapsulates options as passed to the application.
Definition: options.h:35
#define UBUNTU_DLL_PUBLIC
Definition: visibility.h:26