/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_awt_RoadmapItem_idl__
#define __com_sun_star_awt_RoadmapItem_idl__



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

 module com {  module sun {  module star {  module awt {

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

/* specifies a RoadmapItem which serves as an Element in a Container like the Roadmap
 * specified in com::sun::star::awt::UnoControlRoadmapModel and
 * com::sun::star::awt::UnoControlRoadmap
 */
service RoadmapItem
{
    /** The ID uniquely identifies the roadmap item.
     *  When the RoadmapItem is inserted into the Roadmap via "insertByIndex"
     *  the default value of the ID is the first available absolute digit that
     *  has not yet been assigned to other existing RoadmapItems.
    */
     [property] short ID;

    /** The Label of the RoadmapItem does not include its Prefix that is automatically
     * set after the following algorithm:
     * (Index + 1) + ". " + Label
     */
    [property] string Label;


    /** When "Interactive" is true the RoadmapItem supports a certain "HyperLabel
     *  functionality":
     *  Moving the mouse pointer over the RoadmapItem will change it to a Refhand and
     *  underline the Label for the time the mouse pointer resides over the RoadmapItem.
     *  Clicking with mouse pointer will then notify the Roadmap Container.
     *  The property Interactive" is readonly because it is adapted from the container of the
     *  RoadmapItem.
     */
    [property] boolean Interactive;


    /** determines whether a control is enabled or disabled.
     */
    [property] boolean Enabled;
};

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

}; }; }; };

#endif
