/*
   Copyright (C) 2010 Red Hat, Inc.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2.1 of the License, or (at your option) any later version.

   This library 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 library; if not, see <http://www.gnu.org/licenses/>.
*/
#ifndef __SPICE_CLIENT_INPUTS_CHANNEL_H__
#define __SPICE_CLIENT_INPUTS_CHANNEL_H__

#if !defined(__SPICE_CLIENT_H_INSIDE__) && !defined(SPICE_COMPILATION)
#warning "Only <spice-client.h> can be included directly"
#endif

#include "spice-client.h"

G_BEGIN_DECLS

#define SPICE_TYPE_INPUTS_CHANNEL            (spice_inputs_channel_get_type())
#define SPICE_INPUTS_CHANNEL(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj), SPICE_TYPE_INPUTS_CHANNEL, SpiceInputsChannel))
#define SPICE_INPUTS_CHANNEL_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass), SPICE_TYPE_INPUTS_CHANNEL, SpiceInputsChannelClass))
#define SPICE_IS_INPUTS_CHANNEL(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj), SPICE_TYPE_INPUTS_CHANNEL))
#define SPICE_IS_INPUTS_CHANNEL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), SPICE_TYPE_INPUTS_CHANNEL))
#define SPICE_INPUTS_CHANNEL_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), SPICE_TYPE_INPUTS_CHANNEL, SpiceInputsChannelClass))

typedef struct _SpiceInputsChannel SpiceInputsChannel;
typedef struct _SpiceInputsChannelClass SpiceInputsChannelClass;
typedef struct _SpiceInputsChannelPrivate SpiceInputsChannelPrivate;

/**
 * SpiceInputsLock:
 * @SPICE_INPUTS_SCROLL_LOCK: Scroll Lock
 * @SPICE_INPUTS_NUM_LOCK: Num Lock
 * @SPICE_INPUTS_CAPS_LOCK: Caps Lock
 *
 * Constants used to synchronize modifiers between a client and a guest.
 **/
typedef enum {
    SPICE_INPUTS_SCROLL_LOCK = (1 << 0),
    SPICE_INPUTS_NUM_LOCK    = (1 << 1),
    SPICE_INPUTS_CAPS_LOCK   = (1 << 2)
} SpiceInputsLock;

/**
 * SpiceInputsChannel:
 *
 * The #SpiceInputsChannel struct is opaque and should not be accessed directly.
 */
struct _SpiceInputsChannel {
    SpiceChannel parent;

    /*< private >*/
    SpiceInputsChannelPrivate *priv;
    /* Do not add fields to this struct */
};

/**
 * SpiceInputsChannelClass:
 * @parent_class: Parent class.
 * @inputs_modifiers: Signal class handler for the #SpiceInputsChannel::inputs-modifiers signal.
 *
 * Class structure for #SpiceInputsChannel.
 */
struct _SpiceInputsChannelClass {
    SpiceChannelClass parent_class;

    /* signals */
    void (*inputs_modifiers)(SpiceChannel *channel);

    /*< private >*/
    /* Do not add fields to this struct */
};

GType spice_inputs_channel_get_type(void);

void spice_inputs_channel_motion(SpiceInputsChannel *channel, gint dx, gint dy, gint button_state);
void spice_inputs_channel_position(SpiceInputsChannel *channel, gint x, gint y, gint display,
                                   gint button_state);
void spice_inputs_channel_button_press(SpiceInputsChannel *channel, gint button, gint button_state);
void spice_inputs_channel_button_release(SpiceInputsChannel *channel, gint button,
                                         gint button_state);
void spice_inputs_channel_key_press(SpiceInputsChannel *channel, guint scancode);
void spice_inputs_channel_key_release(SpiceInputsChannel *channel, guint scancode);
void spice_inputs_channel_set_key_locks(SpiceInputsChannel *channel, guint locks);
void spice_inputs_channel_key_press_and_release(SpiceInputsChannel *channel, guint scancode);

#ifndef SPICE_DISABLE_DEPRECATED
G_DEPRECATED_FOR(spice_inputs_channel_motion)
void spice_inputs_motion(SpiceInputsChannel *channel, gint dx, gint dy, gint button_state);
G_DEPRECATED_FOR(spice_inputs_channel_position)
void spice_inputs_position(SpiceInputsChannel *channel, gint x, gint y, gint display,
                           gint button_state);
G_DEPRECATED_FOR(spice_inputs_channel_button_press)
void spice_inputs_button_press(SpiceInputsChannel *channel, gint button, gint button_state);
G_DEPRECATED_FOR(spice_inputs_channel_button_release)
void spice_inputs_button_release(SpiceInputsChannel *channel, gint button, gint button_state);
G_DEPRECATED_FOR(spice_inputs_channel_key_press)
void spice_inputs_key_press(SpiceInputsChannel *channel, guint scancode);
G_DEPRECATED_FOR(spice_inputs_channel_key_release)
void spice_inputs_key_release(SpiceInputsChannel *channel, guint scancode);
G_DEPRECATED_FOR(spice_inputs_channel_set_key_locks)
void spice_inputs_set_key_locks(SpiceInputsChannel *channel, guint locks);
G_DEPRECATED_FOR(spice_inputs_channel_key_press_and_release)
void spice_inputs_key_press_and_release(SpiceInputsChannel *channel, guint scancode);
#endif

G_END_DECLS

#endif /* __SPICE_CLIENT_INPUTS_CHANNEL_H__ */
