Rogue Wave Views
Foundation Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvImValue Class Reference

Class to help in Input Method management. More...

#include <ilviews/util/im.h>

Public Member Functions

 IlvImValue ()
 Constructor. More...
 
 IlvImValue (const char *name, IlAny value)
 Constructor. More...
 
IlSymbolgetName () const
 Returns the input context attribute. More...
 
IlAny getValue () const
 Returns the input context attribute value. More...
 
void set (const char *name, IlAny value)
 Sets the name and value. More...
 

Detailed Description

Class to help in Input Method management.

Library: xviews or winviews or mviews (mutually exclusive)

Constructor & Destructor Documentation

IlvImValue::IlvImValue ( )

Constructor.

Initializes a new, empty name/value pair for input context attributes.

IlvImValue::IlvImValue ( const char *  name,
IlAny  value 
)

Constructor.

Initializes a new name/value pair for input context attributes. The following names are supported:

  • imPoint to set the position of the preedit window. In that case the value must be a pointer to an IlvPoint and represents the point located at the baseline of the text where the start of input should take place.
  • imArea to set the size of the preedit window. In that case the value must be a pointer to an IlvRect which represents the bounding box of the object.
  • imFont to set the font of the preedit string. In that case the value must be a pointer to an IlvFont.
  • imBackground to set the background of the preedit window. In that case the value must be a pointer to an IlvColor.
  • imForeground to set the foreground of the preedit window. In that case the value must be a pointer to an IlvColor.
Parameters
nameThe string representing the input context attribute.
valueThe value of the the input context attribute.

Member Function Documentation

IlSymbol* IlvImValue::getName ( ) const

Returns the input context attribute.

Returns
The input context attribute.
IlAny IlvImValue::getValue ( ) const

Returns the input context attribute value.

Returns
A pointer to an input context attribute value.
void IlvImValue::set ( const char *  name,
IlAny  value 
)

Sets the name and value.

Parameters
nameThe name of the input context attribute.
valueA pointer to an input context attribute value.

© Copyright 2016, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.