offapi/com/sun/star/inspection/XStringListControl.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XStringListControl.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_inspection_XStringListControl_idl__
  32 #define __com_sun_star_inspection_XStringListControl_idl__
  33
  34 #ifndef __com_sun_star_inspection_XPropertyControl_idl__
  35 #include <com/sun/star/inspection/XPropertyControl.idl>
  36 #endif
  37
  38 //=============================================================================
  39 module com {  module sun {  module star {  module inspection {
  40
  41 //-----------------------------------------------------------------------------
  42 /** defines the interface for an <type>XPropertyControl</type> which, additionally
  43     to the basic behaviour, supports a list of strings interpreted as possible
  44     property values.
  45
  46     <p>A control which would canonically implement this interface is a list box control:
  47     The string list defined by <type>XStringListControl</type> would in the control be
  48     represented as drop-down list containing all the strings.</p>
  49
  50     @since OOo 2.0.3
  51 */
  52 interface XStringListControl : XPropertyControl
  53 {
  54     /** clears the whole list
  55     */
  56     void clearList();
  57
  58     /** prepends a new entry to the beginning of the list
  59     */
  60     void prependListEntry( [in] string NewEntry );
  61
  62     /** appends a new entry to the end of the list
  63     */
  64     void appendListEntry( [in] string NewEntry );
  65
  66     /** gets all list entries
  67     */
  68     sequence< string > getListEntries();
  69 };
  70
  71 //=============================================================================
  72
  73 }; }; }; };
  74
  75 #endif
  76