summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/report/XSection.idl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 16:51:28 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-27 16:51:28 +0000
commit940b4d1848e8c70ab7642901a68594e8016caffc (patch)
treeeb72f344ee6c3d9b80a7ecc079ea79e9fba8676d /offapi/com/sun/star/report/XSection.idl
parentInitial commit. (diff)
downloadlibreoffice-upstream.tar.xz
libreoffice-upstream.zip
Adding upstream version 1:7.0.4.upstream/1%7.0.4upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/com/sun/star/report/XSection.idl')
-rw-r--r--offapi/com/sun/star/report/XSection.idl165
1 files changed, 165 insertions, 0 deletions
diff --git a/offapi/com/sun/star/report/XSection.idl b/offapi/com/sun/star/report/XSection.idl
new file mode 100644
index 000000000..ae10e2dd8
--- /dev/null
+++ b/offapi/com/sun/star/report/XSection.idl
@@ -0,0 +1,165 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_report_XSection_idl__
+#define __com_sun_star_report_XSection_idl__
+
+#include <com/sun/star/container/XChild.idl>
+#include <com/sun/star/drawing/XShapes.idl>
+#include <com/sun/star/container/XEnumerationAccess.idl>
+#include <com/sun/star/container/XContainer.idl>
+#include <com/sun/star/util/Color.idl>
+#include <com/sun/star/beans/XPropertySet.idl>
+#include <com/sun/star/report/XReportDefinition.idl>
+#include <com/sun/star/report/XReportComponent.idl>
+
+ module com { module sun { module star { module report {
+ interface XGroup;
+
+/** identifies a XSection inside a report.
+
+ <p>A section acts like a container of report components. This generic
+ construction allows the definition of hierarchies of reports and their
+ dependent subreports.</p>
+
+ @see XReportDefinition
+ @see XGroup
+ */
+interface XSection
+{
+ /** allows to navigate to group or report definition.
+ */
+ interface com::sun::star::container::XChild;
+ /** allows to register listeners to be notified of changes in the container.
+ */
+ interface com::sun::star::container::XContainer;
+
+ /** gives access to the elements by index.
+ */
+ interface com::sun::star::drawing::XShapes;
+
+ /** creates an enumeration of the elements.
+ */
+ interface com::sun::star::container::XEnumerationAccess;
+
+ /** provides generic access to the instance properties
+ */
+ interface com::sun::star::beans::XPropertySet;
+
+ /** allows life-time control of sections.
+ */
+ interface com::sun::star::lang::XComponent;
+
+
+ /** Defines if the section should be visible in report.
+ */
+ [attribute,bound] boolean Visible;
+
+ /** Defines the name of the section.
+ */
+ [attribute,bound] string Name;
+
+ /** Defines the height of the section.
+ */
+ [attribute,bound] unsigned long Height;
+
+ /** Defines the background color of the section.
+ */
+ [attribute,bound] com::sun::star::util::Color BackColor;
+
+ /** determines if the background color is set to transparent.
+ */
+ [attribute,bound] boolean BackTransparent;
+
+ /** Defines the expression which is executed before printing the section.
+ If the return value of the expression is `TRUE` then the section will be printed.
+ */
+ [attribute,bound] string ConditionalPrintExpression;
+
+ /** Specifies whether the section is printed on a separate page.
+ <p>Not valid for page header or page footer.</p>
+ @see ForceNewPage
+ */
+ [attribute,bound] short ForceNewPage
+ {
+ set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
+ get raises ( com::sun::star::beans::UnknownPropertyException );
+ };
+
+ /** Specifies whether the section is printed in a new row or column within a multi column report.
+ <p>Not valid for page header or page footer.</p>
+ @see ForceNewPage
+ */
+ [attribute,bound] short NewRowOrCol
+ {
+ set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
+ get raises ( com::sun::star::beans::UnknownPropertyException );
+ };
+
+ /** Specifies that the section is printed on one page.
+ <p>Not valid for page header or page footer.</p>
+ */
+ [attribute,bound] boolean KeepTogether
+ {
+ set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
+ get raises ( com::sun::star::beans::UnknownPropertyException );
+ };
+
+ /** Specifies that elements with dynamic state will be expanded vertically when then content of the element is larger than it's container.
+ If this property is disabled the content will be truncated when its size is larger than the container.
+ */
+ [attribute,bound] boolean CanGrow
+ {
+ set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
+ get raises ( com::sun::star::beans::UnknownPropertyException );
+ };
+
+/**
+ <p>Represents ...</p>
+
+ */
+ [attribute,bound] boolean CanShrink
+ {
+ set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
+ get raises ( com::sun::star::beans::UnknownPropertyException );
+ };
+
+ /** Defines that the group header should be repeated on the next page when a group spans more than one page.
+ It only applies to group headers.
+ */
+ [attribute,bound] boolean RepeatSection
+ {
+ set raises ( com::sun::star::lang::IllegalArgumentException,com::sun::star::beans::UnknownPropertyException );
+ get raises ( com::sun::star::beans::UnknownPropertyException );
+ };
+
+ /** Specifies the parent of the section if it is a group header or group footer.
+ */
+ [attribute,readonly] com::sun::star::report::XGroup Group;
+
+ /** Specifies the parent of the section if it is a page header or page footer.
+ */
+ [attribute,readonly] com::sun::star::report::XReportDefinition ReportDefinition;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */