xref: /aoo42x/main/offapi/com/sun/star/inspection/XStringListControl.idl (revision d695a2a0)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_inspection_XStringListControl_idl__
#define __com_sun_star_inspection_XStringListControl_idl__

#ifndef __com_sun_star_inspection_XPropertyControl_idl__
#include <com/sun/star/inspection/XPropertyControl.idl>
#endif

//=============================================================================
module com {  module sun {  module star {  module inspection {

//-----------------------------------------------------------------------------
/** defines the interface for an <type>XPropertyControl</type> which, additionally
    to the basic behaviour, supports a list of strings interpreted as possible
    property values.

    <p>A control which would canonically implement this interface is a list box control:
    The string list defined by <type>XStringListControl</type> would in the control be
    represented as drop-down list containing all the strings.</p>

    @since OpenOffice 2.0.3
*/
published interface XStringListControl : XPropertyControl
{
    /** clears the whole list
    */
    void clearList();

    /** prepends a new entry to the beginning of the list
    */
    void prependListEntry( [in] string NewEntry );

    /** appends a new entry to the end of the list
    */
    void appendListEntry( [in] string NewEntry );

    /** gets all list entries
    */
    sequence< string > getListEntries();
};

//=============================================================================

}; }; }; };

#endif