idl/Accessibility_Application.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 #ifndef __ACCESSIBILITY_APPLICATION_DEFINED__
  24 #define __ACCESSIBILITY_APPLICATION_DEFINED__
  25
  26 #include <Bonobo.idl>
  27 #include <Accessible.idl>
  28
  29 #if !defined(__ACCESSIBILITY_APPLICATION_COMPILATION) && defined(__ORBIT_IDL__)
  30 %{
  31 #pragma include_defs Application.h
  32 %}
  33 #pragma inhibit push
  34 #endif
  35
  36 #pragma inhibit push
  37 #include "Accessible.idl"
  38 #pragma inhibit pop
  39
  40 module Accessibility {
  41   interface Application : Accessible {
  42
  43     /**
  44      * Get a string indicating the type of user interface toolkit
  45      * which is used by the application.
  46      * Ordinarily clients of @AccessibleApplication should be
  47      * toolkit-agnostic, dependencies on this method probably
  48      * should be reconsidered!
  49      **/
  50     readonly attribute string toolkitName;
  51
  52     /**
  53      * Get a string indicating the version number of the application's
  54      * accessibility bridge implementation.
  55      **/
  56     readonly attribute string version;
  57
  58     /**
  59      * Get the application's process ID in the operating system's
  60      * process table.
  61      *
  62      **/
  63     readonly attribute string id;
  64
  65     /**
  66      * pause:
  67      * Returns: %true if the request succeeded, %false otherwise.
  68      *
  69      * Request that the application temporarily stop sending events.
  70      * In most cases this should pause the application's main event loop.
  71      *
  72      **/
  73     boolean       pause ();
  74
  75     /**
  76      * resume:
  77      * Returns: %true if the request succeeded, %false otherwise.
  78      *
  79      * Request that the application resume sending events.
  80      *
  81      **/
  82     boolean       resume ();
  83   };
  84 };
  85
  86 #if !defined(__ACCESSIBILITY_APPLICATION_COMPILATION) && defined(__ORBIT_IDL__)
  87 #pragma inhibit pop
  88 #endif
  89
  90 #endif