gecko-dev/widget/public/nsIKBStateControl.h

111 строки
3.9 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Frank Tang <ftang@netscape.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#ifndef nsIKBStateControl_h__
#define nsIKBStateControl_h__
#include "nsISupports.h"
// {8C636698-8075-4547-80AD-B032F08EF2D3}
#define NS_IKBSTATECONTROL_IID \
{ 0x8c636698, 0x8075, 0x4547, \
{ 0x80, 0xad, 0xb0, 0x32, 0xf0, 0x8e, 0xf2, 0xd3 } }
/**
* interface to control keyboard input state
*/
class nsIKBStateControl : public nsISupports {
public:
NS_DECLARE_STATIC_IID_ACCESSOR(NS_IKBSTATECONTROL_IID)
/*
* Force Input Method Editor to commit the uncommited input
*/
NS_IMETHOD ResetInputState()=0;
/*
* Following methods relates to IME 'Opened'/'Closed' state.
* 'Opened' means the user can input any character. I.e., users can input Japanese
* and other characters. The user can change the state to 'Closed'.
* 'Closed' means the user can input ASCII characters only. This is the same as a
* non-IME environment. The user can change the state to 'Opened'.
* For more information is here.
* http://bugzilla.mozilla.org/show_bug.cgi?id=16940#c48
*/
/*
* Set the state to 'Opened' or 'Closed'.
* If aState is TRUE, IME open state is set to 'Opened'.
* If aState is FALSE, set to 'Closed'.
*/
NS_IMETHOD SetIMEOpenState(PRBool aState) = 0;
/*
* Get IME is 'Opened' or 'Closed'.
* If IME is 'Opened', aState is set PR_TRUE.
* If IME is 'Closed', aState is set PR_FALSE.
*/
NS_IMETHOD GetIMEOpenState(PRBool* aState) = 0;
/*
* Set the state to 'Enabled' or 'Disabled'.
* If aState is TRUE, IME enable state is set to 'Enabled'.
* If aState is FALSE, set to 'Disabled'.
*/
NS_IMETHOD SetIMEEnabled(PRBool aState) = 0;
/*
* Get IME is 'Enabled' or 'Disabled'.
* If IME is 'Enabled', aState is set PR_TRUE.
* If IME is 'Disabled', aState is set PR_FALSE.
*/
NS_IMETHOD GetIMEEnabled(PRBool* aState) = 0;
/*
* Destruct and don't commit the IME composition string.
*/
NS_IMETHOD CancelIMEComposition() = 0;
};
NS_DEFINE_STATIC_IID_ACCESSOR(nsIKBStateControl, NS_IKBSTATECONTROL_IID)
#endif // nsIKBStateControl_h__