UnoControls/inc/basecontainercontrol.hxx

   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
  20 #ifndef INCLUDED_UNOCONTROLS_INC_BASECONTAINERCONTROL_HXX
  21 #define INCLUDED_UNOCONTROLS_INC_BASECONTAINERCONTROL_HXX
  22
  23 #include <com/sun/star/lang/XServiceName.hpp>
  24 #include <com/sun/star/lang/XServiceInfo.hpp>
  25 #include <com/sun/star/container/XContainer.hpp>
  26 #include <com/sun/star/container/XIndexContainer.hpp>
  27 #include <com/sun/star/container/XNameReplace.hpp>
  28 #include <com/sun/star/container/XContainerListener.hpp>
  29 #include <com/sun/star/container/XSet.hpp>
  30 #include <com/sun/star/container/ContainerEvent.hpp>
  31 #include <com/sun/star/container/XIndexReplace.hpp>
  32 #include <com/sun/star/container/XNameContainer.hpp>
  33 #include <vector>
  34
  35 #include "basecontrol.hxx"
  36
  37 //  "namespaces"
  38
  39 namespace unocontrols{
  40
  41 //  structs, types, forwards
  42
  43 struct IMPL_ControlInfo
  44 {
  45     css::uno::Reference< css::awt::XControl > xControl;
  46     OUString                                  sName;
  47 };
  48
  49 class BaseContainerControl  : public css::awt::XControlModel
  50                             , public css::awt::XControlContainer
  51                             , public BaseControl
  52 {
  53
  54 public:
  55
  56        BaseContainerControl( const css::uno::Reference< css::uno::XComponentContext >& rxContext );
  57
  58     virtual ~BaseContainerControl() override;
  59
  60     //  XInterface
  61
  62     /**_______________________________________________________________________________________________________
  63         @short      give answer, if interface is supported
  64         @descr      The interfaces are searched by type.
  65
  66         @seealso    XInterface
  67
  68         @param      "rType" is the type of searched interface.
  69
  70         @return     Any     information about found interface
  71
  72         @onerror    A RuntimeException is thrown.
  73     */
  74
  75     virtual css::uno::Any SAL_CALL queryInterface(
  76         const css::uno::Type& aType
  77     ) override;
  78
  79     //  XTypeProvider
  80
  81     /**_______________________________________________________________________________________________________
  82         @short      get information about supported interfaces
  83         @seealso    XTypeProvider
  84         @return     Sequence of types of all supported interfaces
  85
  86         @onerror    A RuntimeException is thrown.
  87     */
  88
  89     virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() override;
  90
  91     //  XAggregation
  92
  93     virtual css::uno::Any SAL_CALL queryAggregation(
  94         const css::uno::Type& aType
  95     ) override;
  96
  97     //  XControl
  98
  99     virtual void SAL_CALL createPeer(
 100         const css::uno::Reference< css::awt::XToolkit >&      xToolkit ,
 101         const css::uno::Reference< css::awt::XWindowPeer >&   xParent
 102     ) override;
 103
 104     virtual sal_Bool SAL_CALL setModel(
 105         const css::uno::Reference< css::awt::XControlModel >& xModel
 106     ) override;
 107
 108     virtual css::uno::Reference< css::awt::XControlModel > SAL_CALL getModel() override;
 109
 110     //  XComponent
 111
 112     virtual void SAL_CALL dispose() override;
 113
 114     //  XEventListener
 115
 116     virtual void SAL_CALL disposing( const css::lang::EventObject& rEvent ) override;
 117
 118     //  XControlContainer
 119
 120     virtual void SAL_CALL addControl(
 121         const OUString&                                     sName    ,
 122         const css::uno::Reference< css::awt::XControl >&    xControl
 123     ) override;
 124
 125     virtual void SAL_CALL removeControl(
 126         const css::uno::Reference< css::awt::XControl >& xControl
 127     ) override;
 128
 129     virtual void SAL_CALL setStatusText(
 130         const OUString& sStatusText
 131     ) override;
 132
 133     virtual css::uno::Reference< css::awt::XControl > SAL_CALL getControl(
 134         const OUString& sName
 135     ) override;
 136
 137     virtual css::uno::Sequence< css::uno::Reference< css::awt::XControl > > SAL_CALL getControls() override;
 138
 139     //  XWindow
 140
 141     virtual void SAL_CALL setVisible( sal_Bool bVisible ) override;
 142
 143 protected:
 144     using OComponentHelper::disposing;
 145
 146     virtual css::awt::WindowDescriptor* impl_getWindowDescriptor(
 147         const css::uno::Reference< css::awt::XWindowPeer >& xParentPeer
 148     ) override;
 149
 150
 151     virtual void impl_paint(
 152         sal_Int32                                           nX ,
 153         sal_Int32                                           nY ,
 154         const   css::uno::Reference< css::awt::XGraphics >&   xGraphics
 155     ) override;
 156
 157 private:
 158
 159     void impl_activateTabControllers();
 160
 161     void impl_cleanMemory();
 162
 163     // list of pointer of "struct IMPL_ControlInfo" to hold child-controls
 164     ::std::vector< IMPL_ControlInfo* > maControlInfoList;
 165
 166     // list of references of XTabController to hold tab-order in this container
 167     css::uno::Sequence< css::uno::Reference< css::awt::XTabController > >  m_xTabControllerList;
 168
 169     ::cppu::OMultiTypeInterfaceContainerHelper                          m_aListeners;
 170
 171 };  // class BaseContainerControl
 172
 173 }   // namespace unocontrols
 174
 175 #endif // INCLUDED_UNOCONTROLS_INC_BASECONTAINERCONTROL_HXX
 176
 177 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */