<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /home/espenr/tmp/qt - 3.3.8 - espenr - 2499/qt - x11 - free - 3.3.8/src/kernel/qwindowsystem_qws.cpp:856 -->
< html >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=ISO-8859-1" >
< title > TQWSServer Class< / title >
< style type = "text/css" > < ! - -
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
-->< / style >
< / head >
< body >
< table border = "0" cellpadding = "0" cellspacing = "0" width = "100%" >
< tr bgcolor = "#E5E5E5" >
< td valign = center >
< a href = "index.html" >
< font color = "#004faf" > Home< / font > < / a >
| < a href = "classes.html" >
< font color = "#004faf" > All Classes< / font > < / a >
| < a href = "mainclasses.html" >
< font color = "#004faf" > Main Classes< / font > < / a >
| < a href = "annotated.html" >
< font color = "#004faf" > Annotated< / font > < / a >
| < a href = "groups.html" >
< font color = "#004faf" > Grouped Classes< / font > < / a >
| < a href = "functions.html" >
< font color = "#004faf" > Functions< / font > < / a >
< / td >
< td align = "right" valign = "center" > < img src = "logo32.png" align = "right" width = "64" height = "32" border = "0" > < / td > < / tr > < / table > < h1 align = center > TQWSServer Class Reference< / h1 >
< p > The TQWSServer class provides server-specific functionality in TQt/Embedded.
< a href = "#details" > More...< / a >
< p > < tt > #include < < a href = "qwindowsystem_qws-h.html" > qwindowsystem_qws.h< / a > > < / tt >
< p > < a href = "qwsserver-members.html" > List of all member functions.< / a >
< h2 > Public Members< / h2 >
< ul >
< li class = fn > < a href = "#TQWSServer" > < b > TQWSServer< / b > < / a > ( int flags = 0, TQObject * parent = 0, const char * name = 0 )< / li >
< li class = fn > < a href = "#~TQWSServer" > < b > ~TQWSServer< / b > < / a > ()< / li >
< li class = fn > enum < a href = "#ServerFlags-enum" > < b > ServerFlags< / b > < / a > { DisableKeyboard = 0x01, DisableMouse = 0x02 }< / li >
< li class = fn > enum < a href = "#GUIMode-enum" > < b > GUIMode< / b > < / a > { NoGui = FALSE, NormalGUI = TRUE, Server }< / li >
< li class = fn > void < a href = "#sendIMEvent" > < b > sendIMEvent< / b > < / a > ( IMState state, const TQString & txt, int cpos, int selLen )< / li >
< li class = fn > class < b > KeyMap< / b > { }< / li >
< li class = fn > class < b > KeyOverride< / b > { }< / li >
< li class = fn > class < a href = "#KeyboardFilter" > < b > KeyboardFilter< / b > < / a > { }< / li >
< li class = fn > TQWSWindow * < a href = "#windowAt" > < b > windowAt< / b > < / a > ( const TQPoint & pos )< / li >
< li class = fn > const TQPtrList< TQWSWindow> & < a href = "#clientWindows" > < b > clientWindows< / b > < / a > ()< / li >
< li class = fn > void < a href = "#openMouse" > < b > openMouse< / b > < / a > ()< / li >
< li class = fn > void < a href = "#closeMouse" > < b > closeMouse< / b > < / a > ()< / li >
< li class = fn > void < a href = "#openKeyboard" > < b > openKeyboard< / b > < / a > ()< / li >
< li class = fn > void < a href = "#closeKeyboard" > < b > closeKeyboard< / b > < / a > ()< / li >
< li class = fn > void < a href = "#refresh" > < b > refresh< / b > < / a > ()< / li >
< li class = fn > void < a href = "#refresh-2" > < b > refresh< / b > < / a > ( TQRegion & r )< / li >
< li class = fn > void < a href = "#enablePainting" > < b > enablePainting< / b > < / a > ( bool e )< / li >
< li class = fn > TQWSPropertyManager * < a href = "#manager" > < b > manager< / b > < / a > ()< / li >
< li class = fn > enum < a href = "#WindowEvent-enum" > < b > WindowEvent< / b > < / a > { Create = 0x0001, Destroy = 0x0002, Hide = 0x0004, Show = 0x0008, Raise = 0x0010, Lower = 0x0020, Geometry = 0x0040, Active = 0x0080, Name = 0x0100 }< / li >
< / ul >
< h2 > Signals< / h2 >
< ul >
< li class = fn > void < a href = "#windowEvent" > < b > windowEvent< / b > < / a > ( TQWSWindow * w, TQWSServer::WindowEvent e )< / li >
< li class = fn > void < a href = "#newChannel" > < b > newChannel< / b > < / a > ( const TQString & channel )< / li >
< li class = fn > void < a href = "#removedChannel" > < b > removedChannel< / b > < / a > ( const TQString & channel )< / li >
< / ul >
< h2 > Static Public Members< / h2 >
< ul >
< li class = fn > void < a href = "#sendKeyEvent" > < b > sendKeyEvent< / b > < / a > ( int unicode, int keycode, int modifiers, bool isPress, bool autoRepeat )< / li >
< li class = fn > const KeyMap * < a href = "#keyMap" > < b > keyMap< / b > < / a > ()< / li >
< li class = fn > void < b > setOverrideKeys< / b > ( const KeyOverride * )< / li >
< li class = fn > void < a href = "#setKeyboardFilter" > < b > setKeyboardFilter< / b > < / a > ( KeyboardFilter * f )< / li >
< li class = fn > void < a href = "#setDefaultMouse" > < b > setDefaultMouse< / b > < / a > ( const char * m )< / li >
< li class = fn > void < a href = "#setDefaultKeyboard" > < b > setDefaultKeyboard< / b > < / a > ( const char * k )< / li >
< li class = fn > void < a href = "#setMaxWindowRect" > < b > setMaxWindowRect< / b > < / a > ( const TQRect & r )< / li >
< li class = fn > void < a href = "#setDesktopBackground" > < b > setDesktopBackground< / b > < / a > ( const TQImage & img )< / li >
< li class = fn > void < a href = "#setDesktopBackground-2" > < b > setDesktopBackground< / b > < / a > ( const TQColor & c )< / li >
< li class = fn > TQWSMouseHandler * < a href = "#mouseHandler" > < b > mouseHandler< / b > < / a > ()< / li >
< li class = fn > TQWSKeyboardHandler * < a href = "#keyboardHandler" > < b > keyboardHandler< / b > < / a > ()< / li >
< li class = fn > void < a href = "#setKeyboardHandler" > < b > setKeyboardHandler< / b > < / a > ( TQWSKeyboardHandler * kh )< / li >
< li class = fn > void < a href = "#setScreenSaverIntervals" > < b > setScreenSaverIntervals< / b > < / a > ( int * ms )< / li >
< li class = fn > void < a href = "#setScreenSaverInterval" > < b > setScreenSaverInterval< / b > < / a > ( int ms )< / li >
< li class = fn > bool < a href = "#screenSaverActive" > < b > screenSaverActive< / b > < / a > ()< / li >
< li class = fn > void < a href = "#screenSaverActivate" > < b > screenSaverActivate< / b > < / a > ( bool activate )< / li >
< li class = fn > void < a href = "#setCursorVisible" > < b > setCursorVisible< / b > < / a > ( bool vis )< / li >
< li class = fn > bool < a href = "#isCursorVisible" > < b > isCursorVisible< / b > < / a > ()< / li >
< / ul >
< hr > < a name = "details" > < / a > < h2 > Detailed Description< / h2 >
The TQWSServer class provides server-specific functionality in TQt/Embedded.
< p >
< p > When you run a TQt/Embedded application, it either runs as a server
or connects to an existing server. If it runs as a server, some
additional operations are provided by this class.
< p > This class is instantiated by < a href = "ntqapplication.html" > TQApplication< / a > for TQt/Embedded server
processes. You should never construct this class yourself.
< p > A pointer to the TQWSServer instance can be obtained via the global
< tt > qwsServer< / tt > variable.
< p > The mouse and keyboard devices can be opened with < a href = "#openMouse" > openMouse< / a > () and
< a href = "#openKeyboard" > openKeyboard< / a > (). (Close them with < a href = "#closeMouse" > closeMouse< / a > () and
< a href = "#closeKeyboard" > closeKeyboard< / a > ().)
< p > The display is refreshed with < a href = "#refresh" > refresh< / a > (), and painting can be
enabled or disabled with < a href = "#enablePainting" > enablePainting< / a > ().
< p > Obtain the list of client windows with < a href = "#clientWindows" > clientWindows< / a > () and find
out which window is at a particular point with < a href = "#windowAt" > windowAt< / a > ().
< p > Many static functions are provided, for example,
< a href = "#setKeyboardFilter" > setKeyboardFilter< / a > (), < a href = "#setKeyboardHandler" > setKeyboardHandler< / a > (), < a href = "#setDefaultKeyboard" > setDefaultKeyboard< / a > ()
and < a href = "#setDefaultMouse" > setDefaultMouse< / a > ().
< p > The size of the window rectangle can be set with
< a href = "#setMaxWindowRect" > setMaxWindowRect< / a > (), and the desktop's background can be set with
< a href = "#setDesktopBackground" > setDesktopBackground< / a > ().
< p > The screen saver is controlled with < a href = "#setScreenSaverInterval" > setScreenSaverInterval< / a > () and
< a href = "#screenSaverActivate" > screenSaverActivate< / a > ().
< p > See also < a href = "qws.html" > TQt/Embedded< / a > .
< hr > < h2 > Member Type Documentation< / h2 >
< h3 class = fn > < a name = "GUIMode-enum" > < / a > TQWSServer::GUIMode< / h3 >
< p > This determines what sort of TQWS server to create:
< ul >
< li > < tt > TQWSServer::NoGui< / tt > - This is used for non-graphical TQt applications.
< li > < tt > TQWSServer::NormalGUI< / tt > - A normal TQt/Embedded application (not the server).
< li > < tt > TQWSServer::Server< / tt > - A TQt/Embedded server (e.g. if < tt > -qws< / tt > has been specified
on the command line.
< / ul >
< h3 class = fn > < a name = "ServerFlags-enum" > < / a > TQWSServer::ServerFlags< / h3 >
< p > This enum is used to pass various options to the window system
server.
< ul >
< li > < tt > TQWSServer::DisableKeyboard< / tt > - Ignore all keyboard input.
< li > < tt > TQWSServer::DisableMouse< / tt > - Ignore all mouse input.
< / ul >
< h3 class = fn > < a name = "WindowEvent-enum" > < / a > TQWSServer::WindowEvent< / h3 >
< p > This specifies what sort of event has occurred to a top-level window:
< ul >
< li > < tt > TQWSServer::Create< / tt > - A new window has been created (< a href = "tqwidget.html" > TQWidget< / a > constructor).
< li > < tt > TQWSServer::Destroy< / tt > - The window has been closed and deleted (TQWidget destructor).
< li > < tt > TQWSServer::Hide< / tt > - The window has been hidden with < a href = "tqwidget.html#hide" > TQWidget::hide< / a > ().
< li > < tt > TQWSServer::Show< / tt > - The window has been shown with < a href = "tqwidget.html#show" > TQWidget::show< / a > () or similar.
< li > < tt > TQWSServer::Raise< / tt > - The window has been raised to the top of the desktop.
< li > < tt > TQWSServer::Lower< / tt > - The window has been lowered.
< li > < tt > TQWSServer::Geometry< / tt > - The window has changed size or position.
< li > < tt > TQWSServer::Active< / tt > - The window has become the active window (has < a href = "focus.html#keyboard-focus" > keyboard focus< / a > ).
< li > < tt > TQWSServer::Name< / tt > - The window has been named.
< / ul >
< hr > < h2 > Member Function Documentation< / h2 >
< h3 class = fn > < a name = "TQWSServer" > < / a > TQWSServer::TQWSServer ( int flags = 0, < a href = "tqobject.html" > TQObject< / a > * parent = 0, const char * name = 0 )
< / h3 >
Construct a TQWSServer object.
< p > < b > Warning:< / b > This class is instantiated by < a href = "ntqapplication.html" > TQApplication< / a > for
TQt/Embedded server processes. You should never construct this
class yourself.
< p > The < em > flags< / em > are used for keyboard and mouse setting. The server's
parent is < em > parent< / em > and it is called < em > name< / em > .
< h3 class = fn > < a name = "~TQWSServer" > < / a > TQWSServer::~TQWSServer ()
< / h3 >
Destruct TQWSServer
< h3 class = fn > const < a href = "tqptrlist.html" > TQPtrList< / a > < TQWSWindow> & < a name = "clientWindows" > < / a > TQWSServer::clientWindows ()
< / h3 >
< p > Returns the list of top-level windows. This list will change as
applications add and remove wigdets so it should not be stored for
future use. The windows are sorted in stacking order from
top-most to bottom-most.
< h3 class = fn > void < a name = "closeKeyboard" > < / a > TQWSServer::closeKeyboard ()
< / h3 >
Closes keyboard device(s).
< h3 class = fn > void < a name = "closeMouse" > < / a > TQWSServer::closeMouse ()
< / h3 >
Closes the pointer device(s).
< h3 class = fn > void < a name = "enablePainting" > < / a > TQWSServer::enablePainting ( bool e )
< / h3 >
If < em > e< / em > is TRUE, painting on the display is enabled; if < em > e< / em > is
FALSE, painting is disabled.
< h3 class = fn > bool < a name = "isCursorVisible" > < / a > TQWSServer::isCursorVisible ()< tt > [static]< / tt >
< / h3 >
Returns TRUE if the cursor is visible; otherwise returns FALSE.
< p > < p > See also < a href = "#setCursorVisible" > setCursorVisible< / a > ().
< h3 class = fn > const KeyMap * < a name = "keyMap" > < / a > TQWSServer::keyMap ()< tt > [static]< / tt >
< / h3 >
< p > Returns the keyboard mapping table used to convert keyboard
scancodes to TQt keycodes and Unicode values. It's used by the
keyboard driver in < tt > qkeyboard_qws.cpp< / tt > .
< h3 class = fn > < a href = "qwskeyboardhandler.html" > TQWSKeyboardHandler< / a > * < a name = "keyboardHandler" > < / a > TQWSServer::keyboardHandler ()< tt > [static]< / tt >
< / h3 >
Returns the primary keyboard handler.
< h3 class = fn > TQWSPropertyManager * < a name = "manager" > < / a > TQWSServer::manager ()
< / h3 >
< p > Returns the TQWSPropertyManager, which is used for implementing
X11-style window properties.
< h3 class = fn > < a href = "qwsmousehandler.html" > TQWSMouseHandler< / a > * < a name = "mouseHandler" > < / a > TQWSServer::mouseHandler ()< tt > [static]< / tt >
< / h3 >
Returns the primary mouse handler.
< h3 class = fn > void < a name = "newChannel" > < / a > TQWSServer::newChannel ( const < a href = "tqstring.html" > TQString< / a > & channel )< tt > [signal]< / tt >
< / h3 >
< p > This signal is emitted when the < a href = "qcopchannel.html" > TQCopChannel< / a > < em > channel< / em > is created.
< h3 class = fn > void < a name = "openKeyboard" > < / a > TQWSServer::openKeyboard ()
< / h3 >
Opens the keyboard device(s).
< h3 class = fn > void < a name = "openMouse" > < / a > TQWSServer::openMouse ()
< / h3 >
Opens the mouse device(s).
< h3 class = fn > void < a name = "refresh" > < / a > TQWSServer::refresh ()
< / h3 >
Refreshes the entire display.
< h3 class = fn > void < a name = "refresh-2" > < / a > TQWSServer::refresh ( < a href = "ntqregion.html" > TQRegion< / a > & r )
< / h3 >
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
< p > Refreshes the region < em > r< / em > .
< h3 class = fn > void < a name = "removedChannel" > < / a > TQWSServer::removedChannel ( const < a href = "tqstring.html" > TQString< / a > & channel )< tt > [signal]< / tt >
< / h3 >
< p > This signal is emitted immediately after the < a href = "qcopchannel.html" > TQCopChannel< / a > < em > channel< / em > is destroyed. Note that a channel is not destroyed until
all its listeners have unregistered.
< h3 class = fn > void < a name = "screenSaverActivate" > < / a > TQWSServer::screenSaverActivate ( bool activate )< tt > [static]< / tt >
< / h3 >
If < em > activate< / em > is TRUE the screensaver is activated immediately;
if < em > activate< / em > is FALSE the screensaver is deactivated.
< h3 class = fn > bool < a name = "screenSaverActive" > < / a > TQWSServer::screenSaverActive ()< tt > [static]< / tt >
< / h3 >
Returns TRUE if the screensaver is active (i.e. the screen is
blanked); otherwise returns FALSE.
< h3 class = fn > void < a name = "sendIMEvent" > < / a > TQWSServer::sendIMEvent ( IMState state, const < a href = "tqstring.html" > TQString< / a > & txt, int cpos, int selLen )
< / h3 >
This function sends an input method event to the server. The
current state is passed in < em > state< / em > and the current text in < em > txt< / em > . The cursor's position in the text is given by < em > cpos< / em > , and
the selection length (which could be 0) is given in < em > selLen< / em > .
< h3 class = fn > void < a name = "sendKeyEvent" > < / a > TQWSServer::sendKeyEvent ( int unicode, int keycode, int modifiers, bool isPress, bool autoRepeat )< tt > [static]< / tt >
< / h3 >
Send a key event. You can use this to send key events generated by
"virtual keyboards". < em > unicode< / em > is the Unicode value of the key to
send, < em > keycode< / em > the TQt keycode (e.g. < tt > Key_Left< / tt > ), < em > modifiers< / em >
indicates whether, Shift/Alt/Ctrl keys are pressed, < em > isPress< / em > is
TRUE if this is a key down event and FALSE if it's a key up event,
and < em > autoRepeat< / em > is TRUE if this is an autorepeat event (i.e. the
user has held the key down and this is the second or subsequent
key event being sent).
< h3 class = fn > void < a name = "setCursorVisible" > < / a > TQWSServer::setCursorVisible ( bool vis )< tt > [static]< / tt >
< / h3 >
If < em > vis< / em > is TRUE, makes the cursor visible; if < em > vis< / em > is FALSE,
makes the cursor invisible.
< p > < p > See also < a href = "#isCursorVisible" > isCursorVisible< / a > ().
< h3 class = fn > void < a name = "setDefaultKeyboard" > < / a > TQWSServer::setDefaultKeyboard ( const char * k )< tt > [static]< / tt >
< / h3 >
Set the keyboard driver to < em > k< / em > , e.g. if < tt > $TQWS_KEYBOARD< / tt > is not
defined. The default is platform-dependent.
< h3 class = fn > void < a name = "setDefaultMouse" > < / a > TQWSServer::setDefaultMouse ( const char * m )< tt > [static]< / tt >
< / h3 >
Set the mouse driver < em > m< / em > to use if < tt > $TQWS_MOUSE_PROTO< / tt > is not
defined. The default is platform-dependent.
< h3 class = fn > void < a name = "setDesktopBackground" > < / a > TQWSServer::setDesktopBackground ( const < a href = "tqimage.html" > TQImage< / a > & img )< tt > [static]< / tt >
< / h3 >
Sets the image < em > img< / em > to be used as the background in the absence
of obscuring windows.
< h3 class = fn > void < a name = "setDesktopBackground-2" > < / a > TQWSServer::setDesktopBackground ( const < a href = "ntqcolor.html" > TQColor< / a > & c )< tt > [static]< / tt >
< / h3 >
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
< p > Sets the color < em > c< / em > to be used as the background in the absence of
obscuring windows.
< h3 class = fn > void < a name = "setKeyboardFilter" > < / a > TQWSServer::setKeyboardFilter ( < a href = "qwsserver::keyboardfilter.html" > KeyboardFilter< / a > * f )< tt > [static]< / tt >
< / h3 >
Adds a filter < em > f< / em > to be invoked for all key events from physical
keyboard drivers (events sent via processKeyEvent()).
< p > The filter is not invoked for keys generated by virtual keyboard
drivers (events sent via < a href = "#sendKeyEvent" > sendKeyEvent< / a > ()).
< p > If < em > f< / em > is 0, the most-recently added filter is removed and deleted.
The caller is responsible for matching each addition with a
corresponding removal.
< h3 class = fn > void < a name = "setKeyboardHandler" > < / a > TQWSServer::setKeyboardHandler ( < a href = "qwskeyboardhandler.html" > TQWSKeyboardHandler< / a > * kh )< tt > [static]< / tt >
< / h3 >
Sets the primary keyboard handler to < em > kh< / em > .
< h3 class = fn > void < a name = "setMaxWindowRect" > < / a > TQWSServer::setMaxWindowRect ( const < a href = "ntqrect.html" > TQRect< / a > & r )< tt > [static]< / tt >
< / h3 >
Sets the area of the screen which TQt/Embedded applications will
consider to be the maximum area to use for windows to < em > r< / em > .
< p > < p > See also < a href = "tqwidget.html#showMaximized" > TQWidget::showMaximized< / a > ().
< h3 class = fn > void < a name = "setScreenSaverInterval" > < / a > TQWSServer::setScreenSaverInterval ( int ms )< tt > [static]< / tt >
< / h3 >
Sets the timeout for the screensaver to < em > ms< / em > milliseconds. A
setting of zero turns off the screensaver.
< h3 class = fn > void < a name = "setScreenSaverIntervals" > < / a > TQWSServer::setScreenSaverIntervals ( int * ms )< tt > [static]< / tt >
< / h3 >
Sets an array of timeouts for the screensaver to a list of < em > ms< / em >
milliseconds. A setting of zero turns off the screensaver. The
array must be 0-terminated.
< h3 class = fn > < a href = "qwswindow.html" > TQWSWindow< / a > * < a name = "windowAt" > < / a > TQWSServer::windowAt ( const < a href = "ntqpoint.html" > TQPoint< / a > & pos )
< / h3 >
Returns the window containing the point < em > pos< / em > or 0 if there is no
window under the point.
< h3 class = fn > void < a name = "windowEvent" > < / a > TQWSServer::windowEvent ( < a href = "qwswindow.html" > TQWSWindow< / a > * w, < a href = "qwsserver.html#WindowEvent-enum" > TQWSServer::WindowEvent< / a > e )< tt > [signal]< / tt >
< / h3 >
< p > This signal is emitted whenever something happens to a top-level
window (e.g. it's created or destroyed). < em > w< / em > is the window to
which the event of type < em > e< / em > has occurred.
<!-- eof -->
< hr > < p >
This file is part of the < a href = "index.html" > TQt toolkit< / a > .
Copyright © 1995-2007
< a href = "http://www.trolltech.com/" > Trolltech< / a > . All Rights Reserved.< p > < address > < hr > < div align = center >
< table width = 100% cellspacing = 0 border = 0 > < tr >
< td > Copyright © 2007
< a href = "troll.html" > Trolltech< / a > < td align = center > < a href = "trademarks.html" > Trademarks< / a >
< td align = right > < div align = right > TQt 3.3.8< / div >
< / table > < / div > < / address > < / body >
< / html >
