offapi/com/sun/star/embed/EmbedStates.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_embed_EmbedStates_idl__
  28 #define __com_sun_star_embed_EmbedStates_idl__
  29
  30
  31 //============================================================================
  32
  33 module com { module sun { module star { module embed {
  34
  35 //============================================================================
  36 /** This constant set contains possible states for
  37 <type>EmbeddedObject</type>.
  38 */
  39 published constants EmbedStates
  40 {
  41     //------------------------------------------------------------------------
  42     /** "Loaded" - the persistent representation of the object is loaded in
  43         memory.
  44
  45         <p>
  46         The object is created and assigned with a persistent entry,
  47         and a view representation ( metafile and etc. ) can be retrieved
  48         ( if there is any ).
  49         </p>
  50      */
  51     const long LOADED = 0;
  52
  53     //------------------------------------------------------------------------
  54     /** "Running" - the object is connected and loaded.
  55
  56         <p>
  57         The object has a connection to the container client and a component
  58         loaded from persistent entry. In case of internal document it also
  59         means existing of document model that implements
  60         <type scope="com::sun::star::frame">XModel</type> interface.
  61         </p>
  62      */
  63     const long RUNNING = 1;
  64
  65     //------------------------------------------------------------------------
  66     /** "Active" - the object is activated in separate window
  67         ( outplace activation ).
  68      */
  69     const long ACTIVE = 2;
  70
  71     //------------------------------------------------------------------------
  72     /** "Inplace active" - the object has own window in the container's
  73         window.
  74
  75         <p>
  76         The object is activated and has it's own window in the container's
  77         window that allows object to process mouse events and control own
  78         rendering.
  79         </p>
  80      */
  81     const long INPLACE_ACTIVE = 3;
  82
  83     //------------------------------------------------------------------------
  84     /** "UI active" - the inplace active object that has user interface.
  85
  86         <p>
  87         The object is inplace active, allowed to have menues, toolbars,
  88         keyboard accelerators, and has the focus.
  89         </p>
  90      */
  91     const long UI_ACTIVE = 4;
  92 };
  93
  94 //============================================================================
  95
  96 }; }; }; };
  97
  98 #endif
  99