XEmbeddedObject.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 embed {

published interface XEmbeddedObject
{
    // INTERFACES
    interface XVisualObject;

    interface XClassifiedObject;

    interface XComponentSupplier;

    interface XStateChangeBroadcaster;

    interface ::com::sun::star::document::XEventBroadcaster;

    interface ::com::sun::star::util::XCloseable;

    // METHODS
    void changeState( [in] long nNewState )
        raises( ::com::sun::star::embed::UnreachableStateException,
                ::com::sun::star::embed::WrongStateException,
                ::com::sun::star::uno::Exception );

    sequence< long > getReachableStates()
        raises( ::com::sun::star::embed::NeedsRunningStateException,
                ::com::sun::star::embed::WrongStateException );

    long getCurrentState()
        raises( ::com::sun::star::embed::WrongStateException );

    void doVerb( [in] long nVerbID )
        raises( ::com::sun::star::lang::IllegalArgumentException,
                ::com::sun::star::embed::WrongStateException,
                ::com::sun::star::embed::UnreachableStateException,
                ::com::sun::star::uno::Exception );

    sequence< VerbDescriptor > getSupportedVerbs()
        raises( ::com::sun::star::embed::NeedsRunningStateException,
                ::com::sun::star::embed::WrongStateException );

    void setClientSite( [in] XEmbeddedClient xClient )
        raises( ::com::sun::star::embed::WrongStateException );

    XEmbeddedClient getClientSite()
        raises( ::com::sun::star::embed::WrongStateException );

    void update()
        raises( ::com::sun::star::embed::WrongStateException,
                ::com::sun::star::uno::Exception );

    void setUpdateMode( [in] long nMode )
        raises( ::com::sun::star::embed::WrongStateException );

    hyper getStatus( [in] hyper nAspect )
        raises( ::com::sun::star::embed::WrongStateException );

    void setContainerName( [in] string sName );

};


}; }; }; };

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