options.h
Go to the documentation of this file.
/*
* Copyright © 2013 Canonical Ltd.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3 as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* Authored by: Ricardo Mendoza <ricardo.mendoza@canonical.com>
* Thomas Voß <thomas.voss@canonical.com>
*/
#ifndef UBUNTU_APPLICATION_OPTIONS_H_
#define UBUNTU_APPLICATION_OPTIONS_H_
#include <ubuntu/visibility.h>
#include <ubuntu/application/operation_mode.h>
#ifdef __cplusplus
extern "C" {
#endif
typedef void UApplicationOptions;
UBUNTU_DLL_PUBLIC UApplicationOptions*
u_application_options_new_from_cmd_line(
int argc,
char** argv);
UBUNTU_DLL_PUBLIC void
u_application_options_destroy(
UApplicationOptions *options);
UBUNTU_DLL_PUBLIC UApplicationOperationMode
u_application_options_get_operation_mode(
UApplicationOptions *options);
#ifdef __cplusplus
}
#endif
#endif /* UBUNTU_APPLICATION_OPTIONS_H_ */
UApplicationOperationMode
UApplicationOperationMode
Describes the different operational modes that an application can run in.
Definition: operation_mode.h:27
u_application_options_new_from_cmd_line
UBUNTU_DLL_PUBLIC UApplicationOptions * u_application_options_new_from_cmd_line(int argc, char **argv)
Parses options from the command line.
u_application_options_destroy
UBUNTU_DLL_PUBLIC void u_application_options_destroy(UApplicationOptions *options)
Destroys the options object and releases all resources.
visibility.h
UApplicationOptions
void UApplicationOptions
Encapsulates options as passed to the application.
Definition: options.h:35
UBUNTU_DLL_PUBLIC
#define UBUNTU_DLL_PUBLIC
Definition: visibility.h:26
operation_mode.h
u_application_options_get_operation_mode
UBUNTU_DLL_PUBLIC UApplicationOperationMode u_application_options_get_operation_mode(UApplicationOptions *options)
Queries the operation mode from the supplied options object.