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


module com { module sun { module star { module document {

interface XUndoAction;
interface XUndoManagerListener;


interface XUndoManager
{
    interface ::com::sun::star::util::XLockable;

    interface ::com::sun::star::container::XChild;

    void    enterUndoContext(
                [in] string iTitle
            );

    void    enterHiddenUndoContext()
        raises( EmptyUndoStackException );

    void    leaveUndoContext()
        raises( ::com::sun::star::util::InvalidStateException );

    void    addUndoAction(
                [in] XUndoAction iAction
            )
            raises( ::com::sun::star::lang::IllegalArgumentException );

    void    undo()
            raises( ::com::sun::star::document::EmptyUndoStackException,
                    ::com::sun::star::document::UndoContextNotClosedException,
                    ::com::sun::star::document::UndoFailedException );

    void    redo()
            raises( ::com::sun::star::document::EmptyUndoStackException,
                    ::com::sun::star::document::UndoContextNotClosedException,
                    ::com::sun::star::document::UndoFailedException );

    boolean isUndoPossible();

    boolean isRedoPossible();

    string  getCurrentUndoActionTitle()
            raises( ::com::sun::star::document::EmptyUndoStackException );

    string  getCurrentRedoActionTitle()
            raises( ::com::sun::star::document::EmptyUndoStackException );

    sequence< string >
            getAllUndoActionTitles();

    sequence< string >
            getAllRedoActionTitles();

    void    clear()
            raises( ::com::sun::star::document::UndoContextNotClosedException );

    void    clearRedo()
            raises( ::com::sun::star::document::UndoContextNotClosedException );

    void    reset();

    void    addUndoManagerListener(
                [in] XUndoManagerListener iListener
            );

    void    removeUndoManagerListener(
                [in] XUndoManagerListener iListener
            );
};


}; }; }; };


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