Views
Gadgets Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
IlvCodeEditor::Binding Class Referenceabstract

Holds the key binding for the commands of a Code Editor . More...

#include <ilviews/gadgets/codeedit.h>

Public Member Functions

virtual ~Binding ()
 Destructor.
 
virtual IlBoolean getAccelerator (Accelerator accelerator, char *keyCode, IlvEventType &type, IlUShort &data, IlUShort &mods) const =0
 Returns the description of an accelerator. More...
 

Detailed Description

Holds the key binding for the commands of a Code Editor .

Library: ilvadvgdt

Member Function Documentation

◆ getAccelerator()

virtual IlBoolean IlvCodeEditor::Binding::getAccelerator ( Accelerator  accelerator,
char *  keyCode,
IlvEventType type,
IlUShort data,
IlUShort mods 
) const
pure virtual

Returns the description of an accelerator.

On output, all the parameters except accelerator are set to the values corresponfding to the accelerator description.

Parameters
acceleratorThe accelerator that is queried.
keyCodeThe printable version of the accelerator key code. The caller must make sure that a buffer larger than 32 characters is used.
typeThe type of the accelerator event.
dataThe data attached to the accelerator.
modsThe key modifiers for the accelerator.
Returns
IlTrue if the call was successful, and Ilfalse if it failed looking for the indicated accelerator.