idl/Accessibility_LoginHelper.idl

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2001 Sun Microsystems Inc.
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 #include <Bonobo_Unknown.idl>
  24
  25 #ifndef _ACCESSIBILITY_LOGIN_HELPER_IDL_
  26 #define _ACCESSIBILITY_LOGIN_HELPER_IDL_
  27
  28 module Accessibility {
  29
  30   interface LoginHelper : Bonobo::Unknown {
  31
  32       struct WindowInfo {
  33           long winID;
  34       };
  35
  36       typedef sequence<WindowInfo> WindowList;
  37
  38       enum DeviceReq {
  39           GUI_EVENTS,
  40           CORE_KEYBOARD,
  41           CORE_POINTER,
  42           EXT_INPUT,
  43           POST_WINDOWS,
  44           AUDIO_OUT,
  45           AUDIO_IN,
  46           NETWORK,
  47           LOCALHOST,
  48           SERIAL_OUT,
  49           SERIAL_IN
  50       };
  51
  52       typedef sequence<DeviceReq> DeviceReqList;
  53
  54         /**
  55          * setSafe:
  56          *
  57          * Request a LoginHelper to enter "safe" mode, or
  58          *         inform LoginHelper that "safe" mode may be exited.
  59          *         If @safe_mode is %TRUE, but the return value is %FALSE,
  60          *         the requesting client may wish to deny services to the
  61          *         %LoginHelper, for instance avoid raising its toplevels.
  62          *
  63          * Returns: whether the %LoginHelper is now "safe" or not.
  64          **/
  65         boolean setSafe (in boolean safe_mode);
  66
  67         /**
  68          * getDeviceReqs:
  69          *
  70          * Query a @LoginHelper for the types of
  71          *    device I/O it requires, in order to do its job.
  72          *    For instance, a @LoginHelper which needs to receive keyboard
  73          *    events will include
  74          *    Accessibility_LoginHelper_CORE_KEYBOARD in this list.
  75          *
  76          * Returns: A sequence of @LoginHelper_DeviceFlags indicating
  77          *    the device I/O required.
  78          **/
  79         DeviceReqList getDeviceReqs ();
  80
  81         /**
  82          * getRaiseWindows:
  83          *
  84          * Get a list of window IDs that need raising on login.
  85          *
  86          * Returns: a sequence containing window IDS for toplevels which
  87          *          need to be raised/made visible during user authentication.
  88          **/
  89         WindowList getRaiseWindows ();
  90
  91         /**
  92          * unImplemented:
  93          *
  94          * placeholders for future expansion.
  95          */
  96         void unImplemented ();
  97         void unImplemented2 ();
  98         void unImplemented3 ();
  99         void unImplemented4 ();
 100     };
 101
 102 };
 103
 104 #endif