offapi/com/sun/star/report/XReportControlModel.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
  22 interface XReportControlModel
  23 {
  24     /** allows the creation of sub reports.
  25     */
  26     interface XReportComponent;
  27
  28     interface XReportControlFormat;
  29
  30     /** allows to register listeners to be notified of changes in the container.
  31     */
  32     interface com::sun::star::container::XContainer;
  33
  34     /** gives access to the com::sun::star::report::XFormatCondition elements by index.
  35     */
  36     interface com::sun::star::container::XIndexContainer;
  37
  38     /** Creates a format condition.
  39         @return
  40                report component
  41     */
  42     XFormatCondition createFormatCondition() raises( com::sun::star::uno::Exception );
  43
  44
  45     /** Specifies which content should be shown.
  46
  47         The value can be
  48
  49         - the name of a database column.
  50           The format to use is <code>field:[name]</code>
  51         - the name of a function defined in the report or a group.
  52           The format to use is <code>rpt:[functionName]</code>
  53         - an expression like <code>rpt:24+24-47</code>
  54
  55         @see http://wiki.openoffice.org/wiki/SUN_Report_Builder
  56         @see http://wiki.openoffice.org/wiki/SUN_Report_Builder#Syntax
  57         @see http://wiki.openoffice.org/wiki/Base/Reports/Functions
  58     */
  59     [attribute,bound] string DataField
  60     {
  61         set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
  62         get raises ( com::sun::star::beans::UnknownPropertyException );
  63     };
  64
  65     /** Specifies that the element gets printed when the group changes.
  66         The default value is `TRUE`.
  67     */
  68     [attribute,bound] boolean PrintWhenGroupChange
  69     {
  70         set raises ( com::sun::star::beans::UnknownPropertyException );
  71         get raises ( com::sun::star::beans::UnknownPropertyException );
  72     };
  73
  74     /** Describes the print expression of the report control model.
  75         If the expression evaluates to true than the report control model will be printed otherwise not.
  76     */
  77     [attribute,bound] string ConditionalPrintExpression
  78     {
  79         set raises ( com::sun::star::beans::UnknownPropertyException );
  80         get raises ( com::sun::star::beans::UnknownPropertyException );
  81     };
  82 };
  83
  84
  85 }; }; }; };
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */