udkapi/com/sun/star/lang/SystemDependent.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22 module com {  module sun {  module star {  module lang {
  23
  24 /** These constants are used to specify systems which depend on return values.
  25
  26     <p> You should avoid system-dependent methods if possible.
  27
  28     @code{.cpp}
  29     #ifdef _WIN32 // Microsoft Windows
  30     HWND    hWin = (HWND)xInterface->getWindowHandle(SystemDependentWIN32);
  31     if( hWin ) ...
  32     #elif( ... ) // other systems
  33     ...
  34     #endif
  35     @endcode
  36
  37     <p>The Symbols are now prepended with SYSTEM_ thus we avoid collisions
  38     with system headers.  </p>
  39
  40     @see com::sun::star::awt::XSystemDependentWindowPeer
  41     @deprecated
  42  */
  43 published constants SystemDependent
  44 {
  45     /** The called interface method returns a value specified for Windows.
  46
  47         <p>These are Windows XP or higher. </p>
  48      */
  49     const short SYSTEM_WIN32 = 1;
  50
  51     /** The called interface method returns a value specified for 16-bit Windows.
  52
  53         <p>This is Windows 3.11. </p>
  54      */
  55     const short SYSTEM_WIN16 = 2;
  56
  57     /** The called interface method returns a value specified for Java.
  58
  59         <p>These are <em>JRE 1.1</em>, <em>JRE 1.2</em>, <em>JDK 1.1</em>,
  60         <em>JDK 1.2</em> or higher.   </p>
  61
  62         <p>The return should be a handle to a Java object locked with
  63         the call <code>JavaEnvironment->NewGlobalRef( ... )</code>
  64         by the callee. </p>
  65      */
  66     const short SYSTEM_JAVA = 3;
  67
  68     /** The called interface method returns a value specified for <em>OS/2</em>.
  69      */
  70     const short SYSTEM_OS2 = 4;
  71     /** The called interface method returns a value specified for <em>macOS</em>.
  72      */
  73     const short SYSTEM_MAC = 5;
  74
  75     /** The called interface method returns a value specified for the <em>X Window System</em>.
  76      */
  77     const short SYSTEM_XWINDOW = 6;
  78
  79     /** The called interface method returns a value specified for <em>iOS</em>.
  80      */
  81     const short SYSTEM_IOS = 7;
  82
  83     /** The called interface method returns a value specified for <em>Android</em>.
  84      */
  85     const short SYSTEM_ANDROID = 8;
  86
  87 };
  88
  89
  90 }; }; }; };
  91
  92 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */