/* 
 * Copyright (C) 2011 Daiki Ueno <ueno@unixuser.org>
 * Copyright (C) 2011 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 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA
 */
#ifndef EEK_SYMBOL_H
#define EEK_SYMBOL_H 1

#include <glib-object.h>
#include "eek-types.h"

G_BEGIN_DECLS

/**
 * EekSymbolCategory:
 * @EEK_SYMBOL_CATEGORY_LETTER: the symbol represents an alphabet letter
 * @EEK_SYMBOL_CATEGORY_FUNCTION: the symbol represents a function
 * @EEK_SYMBOL_CATEGORY_KEYNAME: the symbol does not have meaning but
 * have a name
 * @EEK_SYMBOL_CATEGORY_USER0: reserved for future use
 * @EEK_SYMBOL_CATEGORY_USER1: reserved for future use
 * @EEK_SYMBOL_CATEGORY_USER2: reserved for future use
 * @EEK_SYMBOL_CATEGORY_USER3: reserved for future use
 * @EEK_SYMBOL_CATEGORY_USER4: reserved for future use
 * @EEK_SYMBOL_CATEGORY_UNKNOWN: used for error reporting
 *
 * Category of the key symbols.
 */
typedef enum {
    EEK_SYMBOL_CATEGORY_LETTER,
    EEK_SYMBOL_CATEGORY_FUNCTION,
    EEK_SYMBOL_CATEGORY_KEYNAME,
    EEK_SYMBOL_CATEGORY_USER0,
    EEK_SYMBOL_CATEGORY_USER1,
    EEK_SYMBOL_CATEGORY_USER2,
    EEK_SYMBOL_CATEGORY_USER3,
    EEK_SYMBOL_CATEGORY_USER4,
    EEK_SYMBOL_CATEGORY_UNKNOWN,
    /*< private >*/
    EEK_SYMBOL_CATEGORY_LAST = EEK_SYMBOL_CATEGORY_UNKNOWN
} EekSymbolCategory;

#define EEK_TYPE_SYMBOL (eek_symbol_get_type())
#define EEK_SYMBOL(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), EEK_TYPE_SYMBOL, EekSymbol))
#define EEK_SYMBOL_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), EEK_TYPE_SYMBOL, EekSymbolClass))
#define EEK_IS_SYMBOL(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), EEK_TYPE_SYMBOL))
#define EEK_IS_SYMBOL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), EEK_TYPE_SYMBOL))
#define EEK_SYMBOL_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), EEK_TYPE_SYMBOL, EekSymbolClass))

typedef struct _EekSymbolClass EekSymbolClass;
typedef struct _EekSymbolPrivate EekSymbolPrivate;

/**
 * EekSymbol:
 *
 * The #EekSymbol structure contains only private data and should only
 * be accessed using the provided API.
 */
struct _EekSymbol {
    /*< private >*/
    GObject parent;

    EekSymbolPrivate *priv;
};

/**
 * EekSymbolClass:
 */
struct _EekSymbolClass {
    /*< private >*/
    GObjectClass parent_class;
};

GType                 eek_symbol_get_type      (void) G_GNUC_CONST;

EekSymbol            *eek_symbol_new           (const gchar      *name);
void                  eek_symbol_set_name      (EekSymbol        *symbol,
                                                const gchar      *name);
G_CONST_RETURN gchar *eek_symbol_get_name      (EekSymbol        *symbol);
void                  eek_symbol_set_label     (EekSymbol        *symbol,
                                                const gchar      *label);
gchar                *eek_symbol_get_label     (EekSymbol        *symbol);
void                  eek_symbol_set_category  (EekSymbol        *symbol,
                                                EekSymbolCategory category);
EekSymbolCategory     eek_symbol_get_category  (EekSymbol        *symbol);
EekModifierType       eek_symbol_get_modifier_mask
                                               (EekSymbol        *keysym);
void                  eek_symbol_set_modifier_mask
                                               (EekSymbol        *keysym,
                                                EekModifierType   mask);
gboolean              eek_symbol_is_modifier   (EekSymbol        *symbol);
void                  eek_symbol_set_icon_name (EekSymbol        *symbol,
                                                const gchar      *icon_name);
G_CONST_RETURN gchar *eek_symbol_get_icon_name (EekSymbol        *symbol);

G_END_DECLS

#endif  /* EEK_SYMBOL_H */