offapi/com/sun/star/awt/grid/SortableGridDataModel.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
  21 module com { module sun { module star { module awt { module grid {
  22
  23 interface XSortableMutableGridDataModel;
  24 interface XMutableGridDataModel;
  25
  26
  27 /** provides a default implementation of a XSortableGridData.
  28
  29     <p>This service must be created with a secondary grid data model, which all actual data requests are delegated to.
  30     But before providing this data to the service's own clients, it is sorted, according to the sort order defined
  31     via the <code>XSortableGridData</code> interface.</p>
  32
  33     <p>The service implementation is able to compare the default scalar types, plus strings.</p>
  34
  35     <p>For determining the data type of a column which the data should be sorted by, the first non-`VOID` data encountered
  36     in this column is taken into account. Further read requests to this column will assume that all non-`VOID` data is of
  37     the same type.</p>
  38
  39     <p>Consequently, you cannot use this service with data sets containing heterogeneous data in a given column.</p>
  40
  41     <p>All requests made via the XMutableGridDataModel are delegated to the <code>XMutableGridDataModel</code>
  42     instance passed in the service constructor.</p>
  43
  44     <p>Note that changing the data might result in the sort order being destroyed. If you want to ensure
  45     that the data represented by the model is still sorted after your modifications, you should call
  46     XSortableGridData::sortByColumn(), again.</p>
  47  */
  48 service SortableGridDataModel : XSortableMutableGridDataModel
  49 {
  50     /** creates a new instance of the <code>SortableGridDataModel</code>
  51
  52         <p>For string comparison, a default ::com::sun::star::i18n::Collator, based on the system's
  53         locale, will be used.</p>
  54
  55         @param DelegatorModel
  56             the data model to which read requests are delegated.
  57         @throws ::com::sun::star::lang::IllegalArgumentException
  58             if the given <code>DelegatorModel</code> is `NULL`
  59     */
  60     create(
  61             [in] XMutableGridDataModel DelegatorModel
  62         )
  63         raises ( ::com::sun::star::lang::IllegalArgumentException );
  64
  65     /** creates a new instance of the ScortableDefaultGridDataModel, passing a collator to be used for string comparison.
  66
  67         @param DelegatorModel
  68             is the data model to which read requests are delegated
  69         @param Collator
  70             is the collator to be used for string comparison
  71         @throws ::com::sun::star::lang::IllegalArgumentException
  72             if the given <code>DelegatorModel</code> is `NULL`
  73     */
  74     createWithCollator(
  75             [in] XMutableGridDataModel DelegatorModel,
  76             [in] ::com::sun::star::i18n::XCollator Collator
  77         )
  78         raises ( ::com::sun::star::lang::IllegalArgumentException );
  79 };
  80
  81
  82 }; }; }; }; };
  83
  84
  85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */