XTreeControl.idl

Go to the documentation of this file.

/* -*- 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_tree_XTreeControl_idl__
#define __com_sun_star_awt_tree_XTreeControl_idl__

#include <com/sun/star/awt/XControl.idl>
#include <com/sun/star/awt/tree/XTreeExpansionListener.idl>
#include <com/sun/star/view/XMultiSelectionSupplier.idl>
#include <com/sun/star/awt/tree/XTreeEditListener.idl>


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


interface XTreeControl
{
    interface ::com::sun::star::view::XMultiSelectionSupplier;

    // expanding/collapsing/visible

    boolean isNodeExpanded( [in] XTreeNode Node )
        raises( ::com::sun::star::lang::IllegalArgumentException );

    boolean isNodeCollapsed( [in] XTreeNode Node )
        raises( ::com::sun::star::lang::IllegalArgumentException );

    void makeNodeVisible( [in] XTreeNode Node )
        raises( com::sun::star::lang::IllegalArgumentException, ExpandVetoException );

    boolean isNodeVisible( [in] XTreeNode Node )
        raises( com::sun::star::lang::IllegalArgumentException );

    void expandNode( [in] XTreeNode Node )
        raises( com::sun::star::lang::IllegalArgumentException, ExpandVetoException );

    void collapseNode( [in] XTreeNode Node )
        raises( com::sun::star::lang::IllegalArgumentException, ExpandVetoException );

    void addTreeExpansionListener( [in] XTreeExpansionListener Listener );

    void removeTreeExpansionListener( [in] XTreeExpansionListener Listener );

    [attribute] string DefaultExpandedGraphicURL;

    [attribute] string DefaultCollapsedGraphicURL;

    // tree geometry

    XTreeNode getNodeForLocation( [in] long x, [in] long y );

    XTreeNode getClosestNodeForLocation( [in] long x, [in] long y );

    ::com::sun::star::awt::Rectangle
        getNodeRect( [in] XTreeNode Node )
            raises( ::com::sun::star::lang::IllegalArgumentException );

    // tree editing

    boolean isEditing();

    boolean stopEditing();

    void cancelEditing();

    void startEditingAtNode( [in] XTreeNode Node )
        raises( ::com::sun::star::lang::IllegalArgumentException );

    void addTreeEditListener( [in] XTreeEditListener Listener );

    void removeTreeEditListener( [in] XTreeEditListener Listener );
};


}; }; }; }; };

#endif

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