offapi/com/sun/star/awt/XTabControllerModel.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: XTabControllerModel.idl,v $
  10  * $Revision: 1.12 $
  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_XTabControllerModel_idl__
  31 #define __com_sun_star_awt_XTabControllerModel_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_XControlModel_idl__
  38 #include <com/sun/star/awt/XControlModel.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44  module com {  module sun {  module star {  module awt {
  45
  46 //=============================================================================
  47
  48 /** specifies the basic operations for a tab controller model.
  49  */
  50 published interface XTabControllerModel: com::sun::star::uno::XInterface
  51 {
  52     //-------------------------------------------------------------------------
  53
  54     /** returns whether the control models are grouped together.
  55      */
  56     boolean getGroupControl();
  57
  58     //-------------------------------------------------------------------------
  59
  60     /** determines if the control models are grouped together.
  61      */
  62     [oneway] void setGroupControl( [in] boolean GroupControl );
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** sets the control models.
  67      */
  68     [oneway] void setControlModels( [in] sequence<com::sun::star::awt::XControlModel> Controls );
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** returns the control models.
  73      */
  74     sequence<com::sun::star::awt::XControlModel> getControlModels();
  75
  76     //-------------------------------------------------------------------------
  77
  78     /** sets a control model group.
  79      */
  80     [oneway] void setGroup( [in] sequence<com::sun::star::awt::XControlModel> Group,
  81              [in] string GroupName );
  82
  83     //-------------------------------------------------------------------------
  84
  85     /** returns the number of control model groups.
  86      */
  87     long getGroupCount();
  88
  89     //-------------------------------------------------------------------------
  90
  91     /** returns a control model group.
  92      */
  93     void getGroup( [in] long nGroup,
  94              [out] sequence<com::sun::star::awt::XControlModel> Group,
  95              [out] string Name );
  96
  97     //-------------------------------------------------------------------------
  98
  99     /** returns a control model group by name.
 100      */
 101     void getGroupByName( [in] string Name,
 102              [out] sequence<com::sun::star::awt::XControlModel> Group );
 103
 104 };
 105
 106 //=============================================================================
 107
 108 }; }; }; };
 109
 110 #endif