/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* * This file is part of the LibreOffice project. * * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. * * This file incorporates work covered by the following license notice: * * 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 . */ #ifndef __com_sun_star_awt_UnoControlRoadmapModel_idl__ #define __com_sun_star_awt_UnoControlRoadmapModel_idl__ #include #include #include #include module com { module sun { module star { module awt { /** specifies the standard model of a UnoControlContainer. */ service UnoControlRoadmapModel { service com::sun::star::awt::UnoControlModel; /** The control serves as an indexed container typically for RoadmapItems as specified in com::sun::star::awt:RoadmapItem. The RoadmapItems are held in a sequence. When inserting such items their ID is set equal to the Index of their insertion by default. After removing items the CurrentItem property is - when beyond the upper sequence boundaries - set equal to last index of the RoadmapItem Array. */ interface com::sun::star::container::XIndexContainer; /** specifies the background color (RGB) of the control. The Default value is white */ [property] long BackgroundColor; /** determines whether the control is interactive or not.

A roadmap control which is interactive allows selecting its items out-of-order, by simply clicking them.

*/ [property] boolean Interactive; /** determines whether the control container is complete or not. If it is false than a non - interactive RoadmapItem is appended */ [property] boolean Complete; /** specifies a URL to an image to use for the control. The image is placed in the lower right corner of the control @see Graphic */ [property] string ImageURL; /** specifies a graphic to be displayed on the control

If this property is present, it interacts with the #ImageURL in the following way:

  • If #ImageURL is set, #Graphic will be reset to an object as loaded from the given image URL, or `NULL` if #ImageURL does not point to a valid image file.
  • If #Graphic is set, #ImageURL will be reset to an empty string.

@since OOo 2.1 */ [optional, property, transient] com::sun::star::graphic::XGraphic Graphic; /** specifies the border style of the control.
        0: No border
        1: 3D border
        2: simple border
        
*/ [property] short Border; /** specifies whether the control will be printed with the document. */ [property] boolean Printable; /** specifies the text displayed in the control. */ [property] string Text; /** refers to the ID of the currently selected item. Initially this property is set to "-1" which is equal to "undefined" If the Roadmap Item that the CurrentItemID refers to is removed the property "CurrentItemID" is set to -1 */ [property] short CurrentItemID; /** specifies the help text of the control. */ [property] string HelpText; /** specifies the help URL of the control. */ [property] string HelpURL; }; }; }; }; }; #endif /* vim:set shiftwidth=4 softtabstop=4 expandtab: */