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 #ifndef __com_sun_star_lang_SystemDependent_idl__
  20 #define __com_sun_star_lang_SystemDependent_idl__
  21
  22
  23
  24 module com {  module sun {  module star {  module lang {
  25
  26 /** These constants are used to specify systems which depend on return values.
  27
  28     <p> You should avoid system-dependent methods if possible.
  29
  30     @code{.cpp}
  31     #ifdef _WIN32 // Microsoft Windows
  32     HWND    hWin = (HWND)xInterface->getWindowHandle(SystemDependentWIN32);
  33     if( hWin ) ...
  34     #elif( ... ) // other systems
  35     ...
  36     #endif
  37     @endcode
  38
  39     <p>The Symbols are now prepended with SYSTEM_ thus we avoid collisions
  40     with system headers.  </p>
  41
  42     @see com::sun::star::awt::XSystemDependentWindowPeer
  43     @deprecated
  44  */
  45 published constants SystemDependent
  46 {
  47     /** The called interface method returns a value specified for Windows.
  48
  49         <p>These are Windows XP or higher. </p>
  50      */
  51     const short SYSTEM_WIN32 = 1;
  52
  53     /** The called interface method returns a value specified for 16-bit Windows.
  54
  55         <p>This is Windows 3.11. </p>
  56      */
  57     const short SYSTEM_WIN16 = 2;
  58
  59     /** The called interface method returns a value specified for Java.
  60
  61         <p>These are <em>JRE 1.1</em>, <em>JRE 1.2</em>, <em>JDK 1.1</em>,
  62         <em>JDK 1.2</em> or higher.   </p>
  63
  64         <p>The return should be a handle to a Java object locked with
  65         the call <code>JavaEnvironment->NewGlobalRef( ... )</code>
  66         by the callee. </p>
  67      */
  68     const short SYSTEM_JAVA = 3;
  69
  70     /** The called interface method returns a value specified for <em>OS/2</em>.
  71      */
  72     const short SYSTEM_OS2 = 4;
  73     /** The called interface method returns a value specified for <em>Mac OS X</em>.
  74      */
  75     const short SYSTEM_MAC = 5;
  76
  77     /** The called interface method returns a value specified for the <em>X Window System</em>.
  78      */
  79     const short SYSTEM_XWINDOW = 6;
  80
  81     /** The called interface method returns a value specified for <em>iOS</em>.
  82      */
  83     const short SYSTEM_IOS = 7;
  84
  85     /** The called interface method returns a value specified for <em>Android</em>.
  86      */
  87     const short SYSTEM_ANDROID = 8;
  88
  89 };
  90
  91
  92 }; }; }; };
  93
  94 #endif
  95
  96 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */