offapi/com/sun/star/drawing/framework/ResourceId.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ResourceId.idl,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_drawing_framework_ResourceId_idl__
  32 #define __com_sun_star_drawing_framework_ResourceId_idl__
  33
  34 #ifndef __com_sun_star_drawing_framework_XResourceId_idl__
  35 #include <com/sun/star/drawing/framework/XResourceId.idl>
  36 #endif
  37
  38 module com { module sun { module star { module drawing { module framework {
  39
  40 /** The <type>ResourceId</type> service provides several constructors for
  41     resource ids.
  42     <p>They mainly differe in how the anchor is specified.</p>
  43 */
  44 service ResourceId
  45     : XResourceId
  46 {
  47     /** Create an empty resource id.  It does not specify a specific
  48         resource but describes the absence of one.
  49     */
  50     createEmpty ();
  51
  52     /** Create a resource id that has no anchor.
  53         <p>This constructor can be used to create resource ids for panes.</p>
  54     */
  55     create ([in] string sResourceURL);
  56
  57     /** Create a resource id for an anchor that is given as
  58         <type>XResourceId</type> object.  This is the mose general of the
  59         constructor variants.
  60     */
  61     createWithAnchor ([in] string sResourceURL, [in] XResourceId xAnchor);
  62
  63     /** Create a resource id for a resource that is bound to an anchor that
  64         can be specified by a single URL.
  65         <p>This constructor can be used to create resources ids for views
  66         where the anchor is a pane.</p>
  67     */
  68     createWithAnchorURL ([in] string sResourceURL, [in] string sAnchorURL);
  69 };
  70
  71 }; }; }; }; }; // ::com::sun::star::drawing::framework
  72
  73 #endif