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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_awt_XCheckBox_idl__
  20 #define __com_sun_star_awt_XCheckBox_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/awt/XItemListener.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module awt {
  29
  30
  31 /** gives access to the state of a check box and makes it possible
  32     to register for events.
  33  */
  34 published interface XCheckBox: com::sun::star::uno::XInterface
  35 {
  36
  37     /** registers a listener for item events.
  38      */
  39     void addItemListener( [in] com::sun::star::awt::XItemListener l );
  40
  41
  42     /** unregisters a listener for item events.
  43      */
  44     void removeItemListener( [in] com::sun::star::awt::XItemListener l );
  45
  46
  47     /** returns the state of the check box.
  48
  49         @see com::sun::star::awt::UnoControlCheckBoxModel::State
  50      */
  51     short getState();
  52
  53
  54     /** sets the state of the check box.
  55
  56         @see com::sun::star::awt::UnoControlCheckBoxModel::State
  57      */
  58     void setState( [in] short n );
  59
  60
  61     /** sets the label of the check box.
  62      */
  63     void setLabel( [in] string Label );
  64
  65
  66     /** enables or disables the tri state mode.
  67      */
  68     void enableTriState( [in] boolean b );
  69
  70 };
  71
  72
  73 }; }; }; };
  74
  75 #endif
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */