Wide Studio Object Reference

Wide Studio Home
Up to


Class Name

WSDkeyboard

Methods

  • WSDkeyboard* WSGIappKeyboard();   :WSDkeyboard
  • char* getText()   :WSDkeyboard
  • long getKey()   :WSDkeyboard
  • WSCbool withShift();   :WSDkeyboard
  • WSCbool withLock();   :WSDkeyboard
  • WSCbool withCntl();   :WSDkeyboard
  • WSCbool withAlt();   :WSDkeyboard
  • WSCbool isCursorKey();   :WSDkeyboard
  • WSCbool isFuncKey();   :WSDkeyboard


Specification of methods



WSGIappKeyboard method

Form
WSDkeyboard* WSGIappKeyboard()
Function
Returns the global instance of the class: WSDkeyboard.
Description
Parameters
Nothing.
Return value
Returns the global instance.
Notice
This method is a global function. Do not delete the return value.
It is an invarid instance which is created by WSDkeyboard().



getText method

Form
char* getText()
Function
Returns the pressed key by the string.
Description
Parameters
Nothing.
Return value
Returns the string.
Notice
Do not delete the return value.
You can use use this method only on the event:WSEV_KEY_PRESS fired.



getKey method

Form
long getKey()
Function
Returns the pressed key.
Description
Parameters
Nothing.
Return value
Return the key.
Notice
See the file which defined the key: include/WSkeysym.h



withShift method

Form
WSCbool withShift()
Function
Examines whether the shift key is pressed at the same time.
Description
Parameters
Nothing.
Return value
Returns True if pressed; returns False if not.
Notice



withLock method

Form
WSCbool withLock()
Function
Examines whether the CapsLock key is pressed at the same time.
Description
Parameters
Nothing.
Return value
Returns True if pressed; returns False if not.
Notice



withCntl method

Form
WSCbool withCntl()
Function
Examines whether the control key is pressed at the same time.
Description
Parameters
Nothing.
Return value
Returns True if pressed; returns False if not.
Notice



withAlt method

Form
WSCbool withAlt()
Function
Examines whether the alt key is pressed at the same time.
Description
Parameters
Nothing.
Return value
Returns True if pressed; returns False if not.
Notice



isCursorKey method

Form
WSCbool isCursorKey()
Function
Examines whether it is the cursor key.
Description
Parameters
Nothing.
Return value
Returns True if it is; returns False if not.
Notice
There is folloing the cursor keys:
Up,Left,Down,Right,PageUp,PageDown,Begin,End,Next,Home.



isFuncKey method

Form
WSCbool isFuncKey()
Function
Examines whether it is the function key.
Description
Parameters
Nothing.
Return value
Returns True if it is; returns False if not.
Notice
There is folloing the cursor keys:
F1,F2,...,F12.


Document Release 1.0

For Use with Wide Studio Release 1.0, Summer 2000


Wide Stuido Home | Up to

Copyright(C) T. Hirabayashi, 2000 Last modified: July 01, 2000