Quellcode-Bibliothek TreeControlModel.idl   Sprache: C

/* -*- 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 .
 */


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


/** specifies the standard model of a TreeControl.
 */
service TreeControlModel
{
    /** specifies the standard model of a com::sun::star::awt::UnoControl. */
    service ::com::sun::star::awt::UnoControlModel;

    /** Specifies the selection mode that is enabled for this tree.
        <p>The default value is com::sun::star::view::SelectionType::NONE</p>
    */
    [property] ::com::sun::star::view::SelectionType SelectionType;

    /** Specifies the XTreeDataModel that is providing the hierarchical data.

        <p>You can implement your own instance of XTreeDataModel or use
        the MutableTreeDataModel.
    */
    [property] XTreeDataModel DataModel;

    /** Specifies if the root node of the tree is displayed.
        <p>If <var>RootDisplayed</var> is set to `FALSE`, the root node of a model is no longer
        a valid node for the XTreeControl and can't be used with any method of
        XTreeControl.
        <p>The default value is `TRUE`</p>
    */
    [property] boolean RootDisplayed;

    /** Specifies whether the node handles should be displayed.
        <p>The handles are doted lines that visualize the tree like hierarchy<p>
        <p>The default value is `TRUE`</p>
    */
    [property] boolean ShowsHandles;

    /** Specifies whether the node handles should also be displayed at root level.
        <p>The default value is `TRUE`</p>
    */
    [property] boolean ShowsRootHandles;

    /** Specifies the height of each row, in pixels.
        <p>If the specified value is less than or equal to zero, the row height is the maximum height
        of all rows.</p>
        <p>The default value is 0</p>
    */
    [property] long RowHeight;

    /** Specifies whether the nodes of the tree are editable.
        <p>The default value is `FALSE`</p>

        @see XTreeControl::startEditingAtNode()
        @see XTreeEditListener
    */
    [property] boolean Editable;

    /** Specifies what happens when editing is interrupted by selecting another node in the tree,
        a change in the tree's data, or by some other means.
        <p>Setting this property to `TRUE` causes the changes to be automatically saved when editing
        is interrupted. `FALSE` means that editing is canceled and changes are lost
        <p>The default value is `FALSE`</p>
    */
    [property] boolean InvokesStopNodeEditing;
};


}; }; }; }; };

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */