offapi/com/sun/star/awt/XTabController.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XTabController.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_awt_XTabController_idl__
  31 #define __com_sun_star_awt_XTabController_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_XTabControllerModel_idl__
  38 #include <com/sun/star/awt/XTabControllerModel.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_awt_XControlContainer_idl__
  42 #include <com/sun/star/awt/XControlContainer.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_awt_XControl_idl__
  46 #include <com/sun/star/awt/XControl.idl>
  47 #endif
  48
  49
  50 //=============================================================================
  51
  52  module com {  module sun {  module star {  module awt {
  53
  54 //=============================================================================
  55
  56 /** specifies the basic operations for a tab controller.
  57  */
  58 published interface XTabController: com::sun::star::uno::XInterface
  59 {
  60     //-------------------------------------------------------------------------
  61
  62     /** sets the tab controller model.
  63      */
  64     [oneway] void setModel( [in] com::sun::star::awt::XTabControllerModel Model );
  65
  66     //-------------------------------------------------------------------------
  67
  68     /** returns the tab controller model.
  69      */
  70     com::sun::star::awt::XTabControllerModel getModel();
  71
  72     //-------------------------------------------------------------------------
  73
  74     /** set the control container.
  75      */
  76     [oneway] void setContainer( [in] com::sun::star::awt::XControlContainer Container );
  77
  78     //-------------------------------------------------------------------------
  79
  80     /** returns the control container.
  81      */
  82     com::sun::star::awt::XControlContainer getContainer();
  83
  84     //-------------------------------------------------------------------------
  85
  86     /** returns all controls of the control container.
  87      */
  88     sequence<com::sun::star::awt::XControl> getControls();
  89
  90     //-------------------------------------------------------------------------
  91
  92     /** enables automatic tab order.
  93      */
  94     [oneway] void autoTabOrder();
  95
  96     //-------------------------------------------------------------------------
  97
  98     /** activates tab order.
  99      */
 100     [oneway] void activateTabOrder();
 101
 102     //-------------------------------------------------------------------------
 103
 104     /** sets the focus to the first control that can be reached with the
 105         TAB key.
 106      */
 107     [oneway] void activateFirst();
 108
 109     //-------------------------------------------------------------------------
 110
 111     /** sets the focus to the last control that can be reached with the
 112         TAB key.
 113      */
 114     [oneway] void activateLast();
 115
 116 };
 117
 118 //=============================================================================
 119
 120 }; }; }; };
 121
 122 #endif