offapi/com/sun/star/report/XSection.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
  20  module com {  module sun {  module star {  module report {
  21  interface XGroup;
  22
  23 /** identifies a XSection inside a report.
  24
  25     <p>A section acts like a container of report components. This generic
  26     construction allows the definition of hierarchies of reports and their
  27     dependent subreports.</p>
  28
  29     @see XReportDefinition
  30     @see XGroup
  31  */
  32 interface XSection
  33 {
  34     /** allows to navigate to group or report definition.
  35     */
  36     interface com::sun::star::container::XChild;
  37     /** allows to register listeners to be notified of changes in the container.
  38     */
  39     interface com::sun::star::container::XContainer;
  40
  41     /** gives access to the elements by index.
  42     */
  43     interface com::sun::star::drawing::XShapes;
  44
  45     /** creates an enumeration of the elements.
  46     */
  47     interface com::sun::star::container::XEnumerationAccess;
  48
  49     /** provides generic access to the instance properties
  50     */
  51     interface com::sun::star::beans::XPropertySet;
  52
  53     /** allows life-time control of sections.
  54      */
  55     interface com::sun::star::lang::XComponent;
  56
  57
  58     /** Defines if the section should be visible in report.
  59     */
  60     [attribute,bound] boolean Visible;
  61
  62     /** Defines the name of the section.
  63     */
  64     [attribute,bound] string Name;
  65
  66     /** Defines the height of the section.
  67     */
  68     [attribute,bound] unsigned long Height;
  69
  70     /** Defines the background color of the section.
  71     */
  72     [attribute,bound] com::sun::star::util::Color BackColor;
  73
  74     /** determines if the background color is set to transparent.
  75      */
  76     [attribute,bound] boolean BackTransparent;
  77
  78     /** Defines the expression which is executed before printing the section.
  79         If the return value of the expression is `TRUE` then the section will be printed.
  80     */
  81     [attribute,bound] string ConditionalPrintExpression;
  82
  83     /** Specifies whether the section is printed on a separate page.
  84         <p>Not valid for page header or page footer.</p>
  85         @see ForceNewPage
  86     */
  87     [attribute,bound] short ForceNewPage
  88     {
  89         set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
  90         get raises ( com::sun::star::beans::UnknownPropertyException );
  91     };
  92
  93     /** Specifies whether the section is printed in a new row or column within a multi column report.
  94         <p>Not valid for page header or page footer.</p>
  95         @see ForceNewPage
  96     */
  97     [attribute,bound] short NewRowOrCol
  98     {
  99         set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
 100         get raises ( com::sun::star::beans::UnknownPropertyException );
 101     };
 102
 103     /** Specifies that the section is printed on one page.
 104     <p>Not valid for page header or page footer.</p>
 105     */
 106     [attribute,bound] boolean KeepTogether
 107     {
 108         set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
 109         get raises ( com::sun::star::beans::UnknownPropertyException );
 110     };
 111
 112     /** Specifies that elements with dynamic state will be expanded vertically when then content of the element is larger than it's container.
 113         If this property is disabled the content will be truncated when its size is larger than the container.
 114     */
 115     [attribute,bound] boolean CanGrow
 116     {
 117         set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
 118         get raises ( com::sun::star::beans::UnknownPropertyException );
 119     };
 120
 121 /**
 122   <p>Represents ...</p>
 123
 124  */
 125     [attribute,bound] boolean CanShrink
 126     {
 127         set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
 128         get raises ( com::sun::star::beans::UnknownPropertyException );
 129     };
 130
 131     /** Defines that the group header should be repeated on the next page when a group spans more than one page.
 132         It only applies to group headers.
 133     */
 134     [attribute,bound] boolean RepeatSection
 135     {
 136         set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
 137         get raises ( com::sun::star::beans::UnknownPropertyException );
 138     };
 139
 140     /** Specifies the parent of the section if it is a group header or group footer.
 141     */
 142     [attribute,readonly] com::sun::star::report::XGroup Group;
 143
 144     /** Specifies the parent of the section if it is a page header or page footer.
 145     */
 146     [attribute,readonly] com::sun::star::report::XReportDefinition ReportDefinition;
 147 };
 148
 149
 150 }; }; }; };
 151
 152 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */