QWSServer Class Reference
^{[QtGui module]}

Input Method Handling

Custom input methods derived from the QWSInputMethod class, can be installed using the setCurrentInputMethod(). Use the sendIMEvent() and sendIMQuery() functions to send input method events and queries. Finally, QWSServer provides the IMMouse enum describing the various mouse events recognized by the QWSInputMethod::mouseHandler() function. The latter funciton allows subclasses of QWSInputMethod to handle mouse events within the preedit text.

See also QWSClient, Qtopia Core, and Running Applications.

Member Type Documentation

enum QWSServer::IMMouse

This enum describes the various types of mouse events recognized by the QWSInputMethod::mouseHandler() function which allows subclasses of QWSInputMethod to handle mouse events within the preedit text.

See also QWSInputMethod::mouseHandler().

enum QWSServer::WindowEvent

This enum specifies the various events that can occur in a top-level window.

See also windowEvent().

Member Function Documentation

void QWSServer::addKeyboardFilter ( KeyboardFilter * filter )   [static]

Makes the given filter the one invoked for all key events generated by physical keyboard drivers (i.e. events sent using the processKeyEvent() function).

Note that the filter is not invoked for keys generated by virtual keyboard drivers (i.e. events sent using the sendKeyEvent() function).

See also removeKeyboardFilter().

const QBrush & QWSServer::backgroundBrush () const

Returns the brush used as background in the absence of obscuring windows.

See also setBackground().

const QList<QWSWindow *> & QWSServer::clientWindows ()

Returns the list of current top-level windows.

Note that the collection of top-level windows changes as applications add and remove widgets so it should not be stored for future use. The windows are sorted in stacking order from top-most to bottom-most.

See also windowAt() and QWSClient.

void QWSServer::closeKeyboard ()

Closes all the keyboard devices (specified by the QWS_KEYBOARD environment variable) by deleting the associated keyboard handlers.

See also openKeyboard() and keyboardHandler().

void QWSServer::closeMouse ()

Closes all pointer devices (specified by the QWS_MOUSE_PROTO environment variable) by deleting the associated mouse handlers.

See also openMouse() and mouseHandler().

void QWSServer::enablePainting ( bool enable )

If enable is true, painting on the display is enabled; otherwise painting is disabled.

See also QDirectPainter and QScreen.

bool QWSServer::isCursorVisible ()   [static]

Returns true if the cursor is visible; otherwise returns false.

See also setCursorVisible().

const KeyMap * QWSServer::keyMap ()   [static]

Returns the keyboard mapping table used to convert keyboard scancodes to Qt keycodes and Unicode values.

See also KeyMap.

QWSKeyboardHandler * QWSServer::keyboardHandler ()   [static]

Returns the primary keyboard handler.

See also setKeyboardHandler() and openKeyboard().

void QWSServer::markedText ( const QString & selection )   [signal]

This signal is emitted whenever some text is selected in any of the running applications, passing the selected text in the selection parameter.

QWSMouseHandler * QWSServer::mouseHandler ()   [static]

Returns the primary mouse handler.

See also setMouseHandler(), closeMouse(), and openMouse().

void QWSServer::newChannel ( const QString & channel )   [signal]

This signal is emitted whenever a new QCopChannel object is created, passing the channel's name in the channel parameter.

See also removedChannel().

void QWSServer::openKeyboard ()

Opens the keyboard devices specified by the QWS_KEYBOARD environment variable.

See also closeKeyboard() and keyboardHandler().

void QWSServer::openMouse ()

Opens the mouse devices specified by the QWS_MOUSE_PROTO environment variable.

See also closeMouse() and mouseHandler().

void QWSServer::processKeyEvent ( int unicode, int keycode, Qt::KeyboardModifiers modifiers, bool isPress, bool autoRepeat )   [static]

Processes the key event characterized by the given parameters:

Typically, this function is called internally by keyboard drivers.

See also sendKeyEvent(), addKeyboardFilter(), and Character Input.

void QWSServer::refresh ()

Refreshes the entire display.

void QWSServer::refresh ( QRegion & region )

This is an overloaded member function, provided for convenience.

Refreshes the given region of the display.

void QWSServer::removeKeyboardFilter ()   [static]

Removes and deletes the most recently added filter.

Note that the programmer is responsible for matching each addition of a keyboard filter with a corresponding removal.

See also addKeyboardFilter().

void QWSServer::removedChannel ( const QString & channel )   [signal]

This signal is emitted immediately after the QCopChannel object specified by channel, is destroyed.

Note that a channel is not destroyed until all its listeners have been unregistered.

See also newChannel().

void QWSServer::resumeMouse ()

Resumes mouse handling by reactivating each registered mouse handler.

See also suspendMouse(), QWSMouseHandler::resume(), and QWS_MOUSE_PROTO.

void QWSServer::screenSaverActivate ( bool activate )   [static]

Activates the screensaver immediately if the activate is true; otherwise it is deactivated.

See also screenSaverActive().

bool QWSServer::screenSaverActive ()   [static]

Returns true if the screensaver is active (i.e. the screen is blanked); otherwise returns false.

See also screenSaverActivate().

void QWSServer::sendIMEvent ( const QInputMethodEvent * event )

Sends the given input method event.

If there is a window currently in compose mode (i.e. actively composing the preedit string ), the event is sent to that window. Otherwise, the event is sent to the current focus window.

See also sendIMQuery() and QWSInputMethod::sendEvent().

void QWSServer::sendIMQuery ( int property )

Sends an input method query for the specified property.

To receive responses to input method queries the virtual QWSInputMethod::queryResponse() function must be reimplemented in a QWSInputMethod subclass.

See also sendIMEvent() and QWSInputMethod::sendQuery().

void QWSServer::sendKeyEvent ( int unicode, int keycode, Qt::KeyboardModifiers modifiers, bool isPress, bool autoRepeat )   [static]

Sends a key event. Use this function to send key events generated by "virtual keyboards".

See also processKeyEvent() and Character Input.

void QWSServer::setBackground ( const QBrush & brush )   [static]

Sets the brush used as background in the absence of obscuring windows, to be the given brush.

See also backgroundBrush().

void QWSServer::setCurrentInputMethod ( QWSInputMethod * method )   [static]

Sets the current input method to be the given method.

See also sendIMQuery(), sendIMEvent(), and QWSInputMethod.

void QWSServer::setCursorVisible ( bool visible )   [static]

Makes the cursor visible if visible is true: otherwise the cursor is made invisible.

See also isCursorVisible().

void QWSServer::setDefaultKeyboard ( const char * keyboardDriver )   [static]

Sets the keyboard driver that is used if the QWS_KEYBOARD environment variable is not defined, to be the given keyboardDriver. The default is platform-dependent.

See also Character Input.

void QWSServer::setDefaultMouse ( const char * mouseDriver )   [static]

Sets the mouse driver that is used if the QWS_MOUSE_PROTO environment variable is not defined, to be the given mouseDriver. The default is platform-dependent.

See also Pointer Handling.

void QWSServer::setKeyboardHandler ( QWSKeyboardHandler * handler )   [static]

Sets the primary keyboard handler to be the given handler.

Note that it is recommended to use the plugin mechanism instead, deriving from the QKbdDriverPlugin and QKbdDriverFactory classes.

See also keyboardHandler().

void QWSServer::setMaxWindowRect ( const QRect & rectangle )   [static]

Sets the area of the screen which Qtopia Core applications will consider to be the maximum area to use for windows, to the area specified by the given rectangle.

See also QWidget::showMaximized().

void QWSServer::setMouseHandler ( QWSMouseHandler * handler )   [static]

Sets the primary mouse handler to be the given handler.

Note that it is recommended to use the plugin mechanism instead, deriving from the QMouseDriverPlugin and QMouseDriverFactory classes.

See also mouseHandler().

void QWSServer::setScreenSaver ( QWSScreenSaver * screenSaver )   [static]

Deletes the current screensaver and installs the given screenSaver instead.

See also screenSaverActivate().

void QWSServer::setScreenSaverInterval ( int milliseconds )   [static]

Sets the timeout interval for the screensaver to be the specified milliseconds. To turn off the screensaver, set the timout interval to 0.

See also setScreenSaverIntervals().

void QWSServer::setScreenSaverIntervals ( int * intervals )   [static]

Sets a list of timeout intervals (specified in millisecond) for the screensaver. An interval of 0 milliseconds turns off the screensaver.

Note that the array must be 0-terminated.

See also setScreenSaverInterval().

void QWSServer::suspendMouse ()

Suspends mouse handling by suspending each registered mouse handler.

See also resumeMouse(), QWSMouseHandler::suspend(), and QWS_MOUSE_PROTO.

QWSWindow * QWSServer::windowAt ( const QPoint & position )

Returns the window containing the given position, returns 0 if there is no window under the specified point.

See also clientWindows().

void QWSServer::windowEvent ( QWSWindow * window, QWSServer::WindowEvent eventType )   [signal]

This signal is emitted whenever something happens to a top-level window (e.g. it's created or destroyed).

The window to which the event has occurred and the event's type are passed in the window and eventType parameters, respectively.