offapi/com/sun/star/embed/EmbedStates.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_embed_EmbedStates_idl__
  20 #define __com_sun_star_embed_EmbedStates_idl__
  21
  22
  23
  24 module com { module sun { module star { module embed {
  25
  26 /** This constant set contains possible states for
  27 EmbeddedObject.
  28 */
  29 published constants EmbedStates
  30 {
  31     /** "Loaded" - the persistent representation of the object is loaded in
  32         memory.
  33
  34         <p>
  35         The object is created and assigned with a persistent entry,
  36         and a view representation ( metafile and etc. ) can be retrieved
  37         ( if there is any ).
  38         </p>
  39      */
  40     const long LOADED = 0;
  41
  42     /** "Running" - the object is connected and loaded.
  43
  44         <p>
  45         The object has a connection to the container client and a component
  46         loaded from persistent entry. In case of internal document it also
  47         means existing of document model that implements
  48         com::sun::star::frame::XModel interface.
  49         </p>
  50      */
  51     const long RUNNING = 1;
  52
  53     /** "Active" - the object is activated in separate window
  54         ( outplace activation ).
  55      */
  56     const long ACTIVE = 2;
  57
  58     /** "Inplace active" - the object has own window in the container's
  59         window.
  60
  61         <p>
  62         The object is activated and has it's own window in the container's
  63         window that allows object to process mouse events and control own
  64         rendering.
  65         </p>
  66      */
  67     const long INPLACE_ACTIVE = 3;
  68
  69     /** "UI active" - the inplace active object that has user interface.
  70
  71         <p>
  72         The object is inplace active, allowed to have menus, toolbars,
  73         keyboard accelerators, and has the focus.
  74         </p>
  75      */
  76     const long UI_ACTIVE = 4;
  77 };
  78
  79
  80 }; }; }; };
  81
  82 #endif
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */