office-gobmx/offapi/com/sun/star/table/CellRangeListSource.idl
Noel Grandin 2a1b850b78 clean up all the UNO IDL module header guards
.. so I don't keep tripping over the bad ones during my UNO cleanup work.

(1) make them all use a similar syntax, makes it easier to run my automatic checker
(2) some of them were just cut'n'paste accidents waiting to happen
(3) remove unnecessary header guards in the __including__ file. That is very brittle.

Change-Id: I4e679c15161483ad93aeb316a25d6db6d97e9d4e
2012-12-21 09:12:07 +02:00

78 lines
3.1 KiB
Text

/* -*- 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_table_CellRangeListSource_idl__
#define __com_sun_star_table_CellRangeListSource_idl__
#include <com/sun/star/form/binding/ListEntrySource.idl>
#include <com/sun/star/table/CellRangeAddress.idl>
#include <com/sun/star/lang/XInitialization.idl>
module com { module sun { module star { module table {
/** defines the a source of list entries coming from a cell range in a table document
<p>The component cannot be instantiated at a global service factory, instead
it's usually provided by a document instance.</p>
@see com::sun::star::document::OfficeDocument
*/
service CellRangeListSource
{
/** ensures the basic functionality for supplying list entries
*/
service com::sun::star::form::binding::ListEntrySource;
/** specifies the cell range within a document to which the component
is bound.
*/
[property, bound, readonly] com::sun::star::table::CellRangeAddress CellRange;
/** allows setting initial, creation-time properties of the component
<p>This interface is used to initialize the component after creation. It has
to be used exactly once in the life time of the component, every second call
to <member scope"com::sun::star::lang">XInitialization::initialize</member>
will throw an exception.</p>
<p>The arguments passed to the <member scope"com::sun::star::lang">XInitialization::initialize</member>
method must be instances of <type scope="com::sun::star::beans">NamedValue</type>, where
the <member scope"com::sun::star::beans">NamedValue::Name</member> denotes the type of information
to initialize, and the <member scope"com::sun::star::beans">NamedValue::Value</member>
the initial value.</p>
<p>The following aspects of the components can be initialized:<br/>
<ul><li><b>CellRange</b><br/>
specifies the address of the cell range to bind this instance to. Must be a
<type scope="com::sun::star::table">CellRangeAddress</type> instance.</li>
</ul>
</p>
*/
interface com::sun::star::lang::XInitialization;
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */