Quelle  XDataSeries.idl   Sprache: unbekannt

/* -*- 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 .
 */

module com
{
module sun
{
module star
{
module chart2
{

/** A data series represents the object that has all the knowledge to
    be rendered as a visual data series.
 */
interface XDataSeries : ::com::sun::star::uno::XInterface
{
    /** @returns
            the element at the specified index.

        @param nIndex
            specifies the index of the data point within the series. The first index is 0.

        @throws com::sun::star::lang::IndexOutOfBoundsException
            if the index is not valid.
     */
    ::com::sun::star::beans::XPropertySet getDataPointByIndex( [in] long nIndex )
        raises( ::com::sun::star::lang::IndexOutOfBoundsException );

    /** the formatting of the specified data point is cleared

        @param nIndex
            specifies the index of the data point within the series. The first index is 0.
     */
    void resetDataPoint( [in] long nIndex );

    /** all data point formatting are cleared
     */
    void resetAllDataPoints();
};

} ; // chart2
} ; // com
} ; // sun
} ; // star


/* vim:set shiftwidth=4 softtabstop=4 expandtab: */