common/scim-bridge-attribute.h

Go to the documentation of this file.

/*
 * SCIM Bridge
 *
 * Copyright (c) 2006 Ryo Dairiki <ryo-dairiki@users.sourceforge.net>
 *
 *
 * 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 and 
 * appearing in the file LICENSE.LGPL included in the package of this file.
 * You can also redistribute it and/or modify it under the terms of 
 * the GNU General Public License as published by the Free Software Foundation and 
 * appearing in the file LICENSE.GPL included in the package of this file.
 *
 * 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.
 */

#ifndef SCIMBRIDGEATTRIBUTE_H_
#define SCIMBRIDGEATTRIBUTE_H_

#include "scim-bridge.h"

enum _scim_bridge_attribute_type_t
{
    ATTRIBUTE_NONE,
    ATTRIBUTE_DECORATE,
    ATTRIBUTE_FOREGROUND,
    ATTRIBUTE_BACKGROUND
};

typedef enum _scim_bridge_attribute_type_t scim_bridge_attribute_type_t;

typedef unsigned int scim_bridge_attribute_value_t;

typedef struct _ScimBridgeAttribute ScimBridgeAttribute;

static const scim_bridge_attribute_value_t SCIM_BRIDGE_ATTRIBUTE_DECORATE_NONE = 0x1000000;

static const scim_bridge_attribute_value_t SCIM_BRIDGE_ATTRIBUTE_DECORATE_UNDERLINE = 0x2000000;

static const scim_bridge_attribute_value_t SCIM_BRIDGE_ATTRIBUTE_DECORATE_HIGHLIGHT = 0x4000000;

static const scim_bridge_attribute_value_t SCIM_BRIDGE_ATTRIBUTE_DECORATE_REVERSE = 0x8000000;

#ifdef __cplusplus
extern "C"
{
#endif

    ScimBridgeAttribute *scim_bridge_alloc_attribute ();

    void scim_bridge_free_attribute (ScimBridgeAttribute *attribute);

    void scim_bridge_copy_attribute (ScimBridgeAttribute *dst, const ScimBridgeAttribute *src);

    boolean scim_bridge_attribute_equals (const ScimBridgeAttribute *atr1, const ScimBridgeAttribute *atr2);

    scim_bridge_attribute_type_t scim_bridge_attribute_get_type (const ScimBridgeAttribute *attribute);

    void scim_bridge_attribute_set_type (ScimBridgeAttribute *attribute, scim_bridge_attribute_type_t type);

    size_t scim_bridge_attribute_get_begin (const ScimBridgeAttribute *attribute);

    void scim_bridge_attribute_set_begin (ScimBridgeAttribute *attribute, size_t begin);

    size_t scim_bridge_attribute_get_end (const ScimBridgeAttribute *attribute);

    void scim_bridge_attribute_set_end (ScimBridgeAttribute *attribute, size_t end);

    scim_bridge_attribute_type_t scim_bridge_attribute_get_type (const ScimBridgeAttribute *attribute);

    void scim_bridge_attribute_set_type (ScimBridgeAttribute *attribute, scim_bridge_attribute_type_t type);

    scim_bridge_attribute_value_t scim_bridge_attribute_get_value (const ScimBridgeAttribute *attribute);

    void scim_bridge_attribute_set_value (ScimBridgeAttribute *attribute, scim_bridge_attribute_value_t value);

    void scim_bridge_attribute_set_color (ScimBridgeAttribute *attribute, unsigned int red, unsigned int green, unsigned int blue);

    unsigned int scim_bridge_attribute_get_red (const ScimBridgeAttribute *attribute);

    void scim_bridge_attribute_set_red (ScimBridgeAttribute *attribute, unsigned int red);

    unsigned int scim_bridge_attribute_get_green (const ScimBridgeAttribute *attribute);

    void scim_bridge_attribute_set_green (ScimBridgeAttribute *attribute, unsigned int green);

    unsigned int scim_bridge_attribute_get_blue (const ScimBridgeAttribute *attribute);

    void scim_bridge_attribute_set_blue (ScimBridgeAttribute *attribute, unsigned int blue);

#ifdef __cplusplus
}
#endif
#endif                                            /*SCIMBRIDGEATTRIBUTE_H_*/