window_properties.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>           
 */

/*
 * DEPRECATED: In favor of u_application_instance_get_mir_connection
 * and the mir client library
 */

#ifndef UBUNTU_APPLICATION_UI_WINDOW_PROPERTIES_H_
#define UBUNTU_APPLICATION_UI_WINDOW_PROPERTIES_H_

#include <ubuntu/visibility.h>

#include <ubuntu/application/ui/input/event.h>

#ifdef __cplusplus
extern "C" {
#endif

    typedef enum {
        U_MAIN_ROLE = 1,
        U_DASH_ROLE,
        U_INDICATOR_ROLE,
        U_NOTIFICATIONS_ROLE,
        U_GREETER_ROLE,
        U_LAUNCHER_ROLE,
        U_ON_SCREEN_KEYBOARD_ROLE,
        U_SHUTDOWN_DIALOG_ROLE,
    } UAUiWindowRole;

    // Deprecated! Use UAUiWindowEventCb instead
    typedef void (*input_event_cb)(void* ctx, const Event* ev);
    typedef input_event_cb UAUiWindowInputEventCb;

    typedef void (*event_cb)(void* ctx, const WindowEvent* ev);
    typedef event_cb UAUiWindowEventCb;

    typedef void UAUiWindowProperties;

    __attribute__((__deprecated__("Use u_application_instance_get_mir_connection and the mir client library")))
    UBUNTU_DLL_PUBLIC UAUiWindowProperties*
    ua_ui_window_properties_new_for_normal_window();

    __attribute__((__deprecated__("Use u_application_instance_get_mir_connection and the mir client library")))
    UBUNTU_DLL_PUBLIC void
    ua_ui_window_properties_destroy(
        UAUiWindowProperties *properties);

    __attribute__((__deprecated__("Use u_application_instance_get_mir_connection and the mir client library")))
    UBUNTU_DLL_PUBLIC void
    ua_ui_window_properties_set_titlen(
        UAUiWindowProperties *properties,
        const char *title,
        size_t size);

    __attribute__((__deprecated__("Use u_application_instance_get_mir_connection and the mir client library")))
    UBUNTU_DLL_PUBLIC const char*
    ua_ui_window_properties_get_title(
        UAUiWindowProperties *properties);

    __attribute__((__deprecated__("Use u_application_instance_get_mir_connection and the mir client library")))
    UBUNTU_DLL_PUBLIC void
    ua_ui_window_properties_set_role(
        UAUiWindowProperties *properties,
        UAUiWindowRole role);

    __attribute__((__deprecated__("Use u_application_instance_get_mir_connection and the mir client library")))
    UBUNTU_DLL_PUBLIC UAUiWindowRole
    ua_ui_window_properties_get_role(
        UAUiWindowProperties *properties);

    // Deprecated! Use ua_ui_window_properties_set_event_cb_and_ctx instead.
    __attribute__((__deprecated__("Use u_application_instance_get_mir_connection and the mir client library")))
    UBUNTU_DLL_PUBLIC void
    ua_ui_window_properties_set_input_cb_and_ctx(
        UAUiWindowProperties *properties,
        UAUiWindowInputEventCb cb,
        void *ctx);

    UBUNTU_DLL_PUBLIC void
    __attribute__((__deprecated__("Use u_application_instance_get_mir_connection and the mir client library")))
    ua_ui_window_properties_set_event_cb_and_ctx(
        UAUiWindowProperties *properties,
        UAUiWindowEventCb cb,
        void *ctx);

    UBUNTU_DLL_PUBLIC void
    __attribute__((__deprecated__("Use u_application_instance_get_mir_connection and the mir client library")))
    ua_ui_window_properties_set_dimensions(
        UAUiWindowProperties *properties,
        uint32_t width,
        uint32_t height);
    
#ifdef __cplusplus
}
#endif

#endif /* UBUNTU_APPLICATION_UI_WINDOW_PROPERTIES_H_ */