offapi/com/sun/star/style/StyleFamilies.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: StyleFamilies.idl,v $
  10  * $Revision: 1.10 $
  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 #ifndef __com_sun_star_style_StyleFamilies_idl__
  31 #define __com_sun_star_style_StyleFamilies_idl__
  32
  33 #ifndef __com_sun_star_container_XNameAccess_idl__
  34 #include <com/sun/star/container/XNameAccess.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_container_XIndexAccess_idl__
  38 #include <com/sun/star/container/XIndexAccess.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module style {
  45
  46 //=============================================================================
  47
  48 // DocMerge from xml: service com::sun::star::style::StyleFamilies
  49 /** This service contains the collection of style families within the
  50     container document.
  51
  52     <p>Examples of style families may be:
  53     <dl>
  54     <dt>CharacterStyles
  55     </dt>
  56     <dd>the container of style sheets for sequences of characters
  57     within a text
  58
  59     </dd>
  60     <dt>ParagraphStyles
  61     </dt>
  62     <dd>the container of style sheets for text paragraphs
  63
  64     </dd>
  65     <dt>FrameStyles
  66     </dt>
  67     <dd>the container of style sheets for text frames
  68
  69     </dd>
  70     <dt>PageStyles
  71     </dt>
  72     <dd>the container of style sheets for pages
  73
  74     </dd>
  75     <dt>NumberingStyles
  76     </dt>
  77     <dd>the container for style sheets for numbering
  78
  79     </dd>
  80     <dt>CellStyles
  81     </dt>
  82     <dd>the container for style sheets for cells
  83
  84     </dd>
  85     <dt>ShapeStyles
  86     </dt>
  87     <dd>the container for style sheets for shapes
  88     </dd>
  89     </dl>
  90     </p>
  91  */
  92 published service StyleFamilies
  93 {
  94
  95
  96     // DocMerge from xml: service com::sun::star::style::StyleFamilies: interface com::sun::star::container::XNameAccess
  97     /** This mandatory interface makes it possible to get access to the
  98                 style families by their names.
  99
 100                 <p>The elements within this collection are <type>StyleFamily</type> instances.
 101      */
 102     interface com::sun::star::container::XNameAccess;
 103
 104
 105     // DocMerge from xml: service com::sun::star::style::StyleFamilies: interface com::sun::star::container::XIndexAccess
 106     /** This optional interface makes it possible to get access to the
 107                 style families by index.
 108
 109                 <p>The elements within this collection are <type>StyleFamily</type> instances.
 110      */
 111     [optional] interface com::sun::star::container::XIndexAccess;
 112
 113 };
 114
 115 //=============================================================================
 116
 117 }; }; }; };
 118
 119 /*=============================================================================
 120
 121 =============================================================================*/
 122 #endif