offapi/com/sun/star/awt/XControl.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_XControl_idl__
  20 #define __com_sun_star_awt_XControl_idl__
  21
  22 #include <com/sun/star/lang/XComponent.idl>
  23
  24 #include <com/sun/star/uno/XInterface.idl>
  25
  26 #include <com/sun/star/awt/XToolkit.idl>
  27
  28 #include <com/sun/star/awt/XWindowPeer.idl>
  29
  30 #include <com/sun/star/awt/XControlModel.idl>
  31
  32 #include <com/sun/star/awt/XView.idl>
  33
  34
  35
  36  module com {  module sun {  module star {  module awt {
  37
  38
  39 /** identifies a control.
  40
  41     <p>Implementations of this interface are abstract windows.
  42     The main reason to instantiate this implementation is to show the window
  43     on the screen. Before the window appears on the screen, the
  44     XControl::createPeer() method must be called.</p>
  45
  46     <p>If the implementation of the control does not distinguish
  47     between model, view and controller, it must allow to set
  48     a new XGraphics in the view, so that the control can be printed.</p>
  49  */
  50 published interface XControl: com::sun::star::lang::XComponent
  51 {
  52
  53     /** sets the context of the control.
  54      */
  55     void setContext( [in] com::sun::star::uno::XInterface Context );
  56
  57
  58     /** gets the context of the control.
  59      */
  60     com::sun::star::uno::XInterface getContext();
  61
  62
  63     /** creates a "child" window on the screen.
  64
  65         <p>If the parent is NULL, then the desktop window of the toolkit
  66         is the parent.</p>
  67      */
  68     void createPeer( [in] com::sun::star::awt::XToolkit Toolkit,
  69              [in] com::sun::star::awt::XWindowPeer Parent );
  70
  71
  72     /** returns the peer which was previously created or set.
  73      */
  74     com::sun::star::awt::XWindowPeer getPeer();
  75
  76
  77     /** sets a model for the control.
  78      */
  79     boolean setModel( [in] com::sun::star::awt::XControlModel Model );
  80
  81
  82     /** returns the model for this control.
  83      */
  84     com::sun::star::awt::XControlModel getModel();
  85
  86
  87     /** returns the view of this control.
  88      */
  89     com::sun::star::awt::XView getView();
  90
  91
  92     /** sets the design mode for use in a design editor.
  93
  94         <p>Normally the control will be painted directly without a peer.</p>
  95      */
  96     void setDesignMode( [in] boolean bOn );
  97
  98
  99     /** returns `TRUE` if the control is in design mode, `FALSE` otherwise.
 100      */
 101     boolean isDesignMode();
 102
 103
 104     /** returns `TRUE` if the control is transparent, `FALSE` otherwise.
 105      */
 106     boolean isTransparent();
 107
 108 };
 109
 110
 111 }; }; }; };
 112
 113 #endif
 114
 115 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */