home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / opendc12.zip / od124os2.exe / od12osr1.exe / src / Arbitrat.idl < prev    next >
Text File  |  1997-03-21  |  6KB  |  189 lines
  1. /* @(#)Z 1.2 com/src/ui/idl/Arbitrat.idl, odui, od96os2, odos29712d 97/03/21 17:20:46 (96/07/15 18:28:15) */
  2. //#====START_GENERATED_PROLOG======================================
  3. //#
  4. //#
  5. //#   COMPONENT_NAME: odui
  6. //#
  7. //#   CLASSES: none
  8. //#
  9. //#   ORIGINS: 82,27
  10. //#
  11. //#
  12. //#   (C) COPYRIGHT International Business Machines Corp. 1995,1996
  13. //#   All Rights Reserved
  14. //#   Licensed Materials - Property of IBM
  15. //#   US Government Users Restricted Rights - Use, duplication or
  16. //#   disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
  17. //#       
  18. //#   IBM DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
  19. //#   ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  20. //#   PURPOSE. IN NO EVENT SHALL IBM BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  21. //#   CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
  22. //#   USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
  23. //#   OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE
  24. //#   OR PERFORMANCE OF THIS SOFTWARE.
  25. //#
  26. //#====END_GENERATED_PROLOG========================================
  27. //#
  28. #ifdef __PRIVATE__
  29. //#
  30. //#    File:        Arbitrat.idl
  31. //#
  32. //#    Contains:    Class definition for ODArbitrator
  33. //#
  34. //#    Owned by:    Richard Rodseth
  35. //#
  36. //#    Copyright:    (r) 1993 - 1995 by Apple Computer, Inc., all rights reserved.
  37. //#
  38. //#    Change History (most recent first):
  39. //#
  40. //#         <8>     8/15/95    RR        #1275241 IDL Review
  41. //#         <7>      8/3/95    RR        #1257260: Collapse B classes. Remove
  42. //#                                    somInit methods. Don't call IsInitialized
  43. //#                                    or SubclassResponsibility
  44. //#         <6>     5/25/95    VL        1251403: Multithreading naming support.
  45. //#         <5>    10/18/94    RR        Removed unused private methods
  46. //#                                    BeginRequestFocus etc.
  47. //#         <4>      9/1/94    CC        RADAR #1181971 - missing factory methods
  48. //#                                    (for JBS)
  49. //#         <3>      8/4/94    eeh        bug 1177981: make GetFocusModule public
  50. //#         <2>     6/15/94    RR        Added function prefix
  51. //#         <1>      6/8/94    RR        first checked in
  52. //#         <9>      6/2/94    RR        Testing
  53. //#         <7>     5/12/94    RR    inout->in        
  54. //#         <7>     5/12/94    RR        
  55. //#
  56. //#    To Do:
  57. //#
  58. #else
  59. //#    Copyright:    (r) 1993 - 1995 by Apple Computer, Inc., all rights reserved.
  60. #endif
  61.  
  62. #ifndef _ARBITRAT_
  63. #define _ARBITRAT_
  64.  
  65. #ifndef _ODOBJECT_
  66. #include "ODObject.idl"
  67. #endif
  68.  
  69. //=====================================================================================
  70. // Class defined in this interface
  71. //=====================================================================================
  72.  
  73. interface  ODArbitrator;
  74.  
  75. //=====================================================================================
  76. // Classes used by this interface
  77. //=====================================================================================
  78.  
  79. interface  ODFocusModule;
  80. interface  ODFocusSet;
  81. interface  ODFocusOwnerIterator;
  82. interface  ODFrame;
  83.  
  84. #ifdef __PRIVATE__
  85. interface  ODSession;
  86. #endif
  87.  
  88. #ifdef __PRIVATE__
  89. //=====================================================================================
  90. // Implementation Types
  91. //=====================================================================================
  92.  
  93. typedef somToken DictionaryList;
  94. #endif
  95.  
  96. //=====================================================================================
  97. // Class ODArbitrator
  98. //=====================================================================================
  99.  
  100. interface ODArbitrator :  ODObject
  101. {    
  102.    ODBoolean RequestFocusSet(in ODFocusSet focusSet,
  103.                                  in ODFrame requestingFrame);
  104.     
  105.    ODBoolean RequestFocus(in ODTypeToken focus,
  106.                               in ODFrame requestingFrame);
  107.         
  108.    void RelinquishFocusSet(in ODFocusSet focusSet,
  109.                               in ODFrame relinquishingFrame);
  110.         
  111.    void RelinquishFocus(in ODTypeToken focus,
  112.                            in ODFrame relinquishingFrame);
  113.   
  114.    void TransferFocus(in ODTypeToken focus,
  115.                          in ODFrame transferringFrame,
  116.                       in ODFrame newOwner);
  117.                  
  118.    void TransferFocusSet(in ODFocusSet focusSet, 
  119.                            in ODFrame transferringFrame,
  120.                         in ODFrame newOwner);
  121.                  
  122.    ODFrame AcquireFocusOwner(in ODTypeToken focus);
  123.     
  124.    ODFocusOwnerIterator CreateOwnerIterator(in ODTypeToken focus);
  125.           
  126.    void RegisterFocus(in ODTypeToken focus,
  127.                          in ODFocusModule focusModule);
  128.       
  129.    void UnregisterFocus(in ODTypeToken focus);
  130.  
  131.    ODBoolean IsFocusRegistered(in ODTypeToken focus);
  132.   
  133.    ODBoolean IsFocusExclusive(in ODTypeToken focus);
  134.   
  135.    ODFocusModule GetFocusModule(in ODTypeToken focus);
  136.    
  137.    ODFocusSet CreateFocusSet();
  138.  
  139. #ifdef __PRIVATE__
  140.  
  141.    void InitArbitrator(in ODSession session);
  142.  
  143. #endif //# __PRIVATE__
  144.  
  145. #ifdef __SOMIDL__
  146.     implementation
  147.     {
  148.         majorversion = 1; minorversion = 0;
  149.         
  150.         functionprefix = ODArbitrator;
  151.         
  152.         override:
  153.             somUninit,
  154.             Purge;
  155.         releaseorder:
  156.             RequestFocusSet,
  157.             RequestFocus,
  158.             RelinquishFocusSet,
  159.             RelinquishFocus,
  160.             TransferFocus,
  161.             TransferFocusSet,
  162.             AcquireFocusOwner,
  163.             CreateOwnerIterator,
  164.             RegisterFocus,
  165.             UnregisterFocus,
  166.             IsFocusRegistered,
  167.             IsFocusExclusive,
  168.             GetFocusModule,
  169.             CreateFocusSet,
  170.         #ifdef __PRIVATE__
  171.             InitArbitrator;
  172.         #else
  173.             reserved1;
  174.         #endif
  175.  
  176.  
  177.     #ifdef __PRIVATE__
  178.         passthru C_xih = "class DictionaryList;";
  179.         
  180.         ODSession        fSession;
  181.         DictionaryList*    fFocusModules;
  182.     #endif //# __PRIVATE__
  183.     
  184.   };
  185. #endif //# __SOMIDL__
  186. };
  187.  
  188. #endif //# _ARBITRAT_
  189.