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