agent/scim-bridge-agent-protected.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 SCIMBRIDGEAGENTPROTECTED_H_
#define SCIMBRIDGEAGENTPROTECTED_H_

#define Uses_SCIM_EVENT
#define Uses_SCIM_TRANSACTION

#include <scim.h>

#include "scim-bridge-display.h"
#include "scim-bridge-imcontext.h"

class ScimBridgeAgentClientListener;
class ScimBridgeAgentIMContext;
class ScimBridgeAgentPanelListener;

class ScimBridgeAgentProtected
{

    public:

        virtual ~ScimBridgeAgentProtected () {}

        virtual void interrupt () = 0;

        virtual void quit () = 0;

        virtual void load_config () = 0;

        virtual void save_config () = 0;

        virtual void add_client_listener (ScimBridgeAgentClientListener *client_listener) = 0;

        virtual void remove_client_listener (ScimBridgeAgentClientListener *client_listener) = 0;

        virtual bool filter_hotkeys (scim_bridge_imcontext_id_t imcontext_id, const scim::KeyEvent &key_event) = 0;

        virtual bool filter_key_event (scim_bridge_imcontext_id_t imcontext_id, const scim::KeyEvent &key_event) = 0;

        virtual void request_factory_menu () = 0;

        virtual scim_bridge_imcontext_id_t alloc_imcontext (ScimBridgeAgentClientListener *client_listener) = 0;

        virtual void free_imcontext (scim_bridge_imcontext_id_t imcontext_id, const ScimBridgeAgentClientListener *client_listener) = 0;

        virtual void reset_imcontext (scim_bridge_imcontext_id_t imcontext_id) = 0;

        virtual void set_cursor_location (scim_bridge_imcontext_id_t imcontext_id, int cursor_x, int cursor_y) = 0;

        virtual void set_preedit_mode (scim_bridge_imcontext_id_t imcontext_id, scim_bridge_preedit_mode_t preedit_mode) = 0;

        virtual void change_focus (scim_bridge_imcontext_id_t imcontext_id, bool focus_in) = 0;

    protected:

        ScimBridgeAgentProtected () {}

};
#endif                                            /*SCIMBRIDGEAGENTPROTECTED_H_*/