xref: /aoo42x/main/udkapi/com/sun/star/script/XDefaultProperty.idl (revision 408a4873)

/**************************************************************
 *
 * 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_script_XDefaultProperty_idl__
#define __com_sun_star_script_XDefaultProperty_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

module com { module sun { module star { module script {
//==============================================================================
/**
    An object supporting this interface indicates to interested
    parties or clients the name of the default propery for
    this object.
    <p>For example where ExampleObject is an instance of an Object that
    supports this interface which returns the default property name
    "Value".A scripting engine could use this information to support
    syntax like <p>ExampleObject = "foo"</p>
    which would be equivalent to writing
    <p>ExampleObject.Value = "foo"</p>
    or
    <p>bar = ExampleObject</p>
    which would be equivalent to writing
    <p>bar = ExampleObject.Value</p>
*/
interface XDefaultProperty : ::com::sun::star::uno::XInterface
{
  //-----------------------------------------------------------------------
  /**
    Returns the name of the default property

    @return
     The <atom>string</atom> name of default property
  */
  string getDefaultPropertyName();

};

};  };  };  };
#endif