offapi/com/sun/star/sheet/XMembersAccess.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
  10
  11 module com {  module sun {  module star {  module sheet {
  12
  13
  14 /** is used to access named members in a data pilot source
  15     level collection.
  16
  17     @see com::sun::star::sheet::DataPilotSourceMember
  18  */
  19 interface XMembersAccess: com::sun::star::container::XNameAccess
  20 {
  21
  22     /** returns names of data pilot members in a locale independent
  23         notation.
  24
  25         <p> Specifically date values are represented in an ISO 8601
  26         YYYY-MM-DD notation and date+time as YYYY-MM-DD HH:MM:SS,
  27         whereas the strings returned by
  28         com::sun::star::container::XNameAccess::getElementNames() may
  29         represent these in a locale dependent or user formatted notation
  30         such as MM/DD/YY or DD.MM.YYYY or other. </p>
  31
  32         <p> The names returned by this function can NOT be used in calls
  33         to com::sun::star::container::XNameAccess::getByName(). However,
  34         the order returned in two immediately consecutive calls to
  35         getElementNames() and getLocaleIndependentElementNames() maps to
  36         the same elements in order. </p>
  37
  38         @returns
  39             a sequence of all element names in this container.
  40
  41      */
  42     sequence<string> getLocaleIndependentElementNames();
  43
  44 };
  45
  46
  47 }; }; }; };
  48
  49 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */