xref: /aoo41x/main/offapi/com/sun/star/awt/XTabController.idl (revision d1766043)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_awt_XTabController_idl__
#define __com_sun_star_awt_XTabController_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_awt_XTabControllerModel_idl__
#include <com/sun/star/awt/XTabControllerModel.idl>
#endif

#ifndef __com_sun_star_awt_XControlContainer_idl__
#include <com/sun/star/awt/XControlContainer.idl>
#endif

#ifndef __com_sun_star_awt_XControl_idl__
#include <com/sun/star/awt/XControl.idl>
#endif


//=============================================================================

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

//=============================================================================

/** specifies the basic operations for a tab controller.
 */
published interface XTabController: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

    /** sets the tab controller model.
     */
	[oneway] void setModel( [in] com::sun::star::awt::XTabControllerModel Model );

	//-------------------------------------------------------------------------

    /** returns the tab controller model.
     */
	com::sun::star::awt::XTabControllerModel getModel();

	//-------------------------------------------------------------------------

    /** set the control container.
     */
	[oneway] void setContainer( [in] com::sun::star::awt::XControlContainer Container );

	//-------------------------------------------------------------------------

    /** returns the control container.
     */
	com::sun::star::awt::XControlContainer getContainer();

	//-------------------------------------------------------------------------

    /** returns all controls of the control container.
     */
	sequence<com::sun::star::awt::XControl> getControls();

	//-------------------------------------------------------------------------

    /** enables automatic tab order.
     */
	[oneway] void autoTabOrder();

	//-------------------------------------------------------------------------

    /** activates tab order.
     */
	[oneway] void activateTabOrder();

	//-------------------------------------------------------------------------

    /** sets the focus to the first control that can be reached with the
        TAB key.
     */
	[oneway] void activateFirst();

	//-------------------------------------------------------------------------

    /** sets the focus to the last control that can be reached with the
        TAB key.
     */
	[oneway] void activateLast();

};

//=============================================================================

}; }; }; };

#endif