offapi/com/sun/star/inspection/XStringListControl.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 #ifndef __com_sun_star_inspection_XStringListControl_idl__
  21 #define __com_sun_star_inspection_XStringListControl_idl__
  22
  23 #include <com/sun/star/inspection/XPropertyControl.idl>
  24
  25 module com {  module sun {  module star {  module inspection {
  26
  27 /** defines the interface for an XPropertyControl which, additionally
  28     to the basic behavior, supports a list of strings interpreted as possible
  29     property values.
  30
  31     <p>A control which would canonically implement this interface is a list box control:
  32     The string list defined by XStringListControl would in the control be
  33     represented as drop-down list containing all the strings.</p>
  34
  35     @since OOo 2.0.3
  36 */
  37 interface XStringListControl : XPropertyControl
  38 {
  39     /** clears the whole list
  40     */
  41     void clearList();
  42
  43     /** prepends a new entry to the beginning of the list
  44     */
  45     void prependListEntry( [in] string NewEntry );
  46
  47     /** appends a new entry to the end of the list
  48     */
  49     void appendListEntry( [in] string NewEntry );
  50
  51     /** gets all list entries
  52     */
  53     sequence< string > getListEntries();
  54 };
  55
  56
  57 }; }; }; };
  58
  59 #endif
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */