dbaccess/inc/IController.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef DBAUI_ICONTROLLER_HXX
  30 #define DBAUI_ICONTROLLER_HXX
  31
  32 #include <com/sun/star/beans/PropertyValue.hpp>
  33 #include <com/sun/star/uno/Sequence.hxx>
  34 #include "IReference.hxx"
  35 #include "dbaccessdllapi.h"
  36
  37 namespace com { namespace sun { namespace star {
  38     namespace util {
  39         struct URL;
  40     }
  41     namespace frame {
  42         class XController;
  43     }
  44 } } }
  45
  46 class NotifyEvent;
  47
  48 namespace dbaui
  49 {
  50     // interface for controller depended calls like commands
  51     class DBACCESS_DLLPUBLIC IController : public IReference
  52     {
  53     public:
  54         /** executes the given command without checking if it is allowed
  55             @param  _rCommand   the URL of the command
  56         */
  57         virtual void executeUnChecked(const ::com::sun::star::util::URL& _rCommand, const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue>& aArgs) = 0;
  58
  59         /** executes the given command only when it is allowed
  60             @param  _rCommand
  61                 the URL of the command
  62         */
  63         virtual void executeChecked(const ::com::sun::star::util::URL& _rCommand, const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue>& aArgs) = 0;
  64
  65         /** executes the given command without checking if it is allowed
  66             @param  _nCommandId
  67                 the id of the command URL
  68         */
  69         virtual void executeUnChecked(sal_uInt16 _nCommandId, const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue>& aArgs) = 0;
  70
  71         /** executes the given command only when it is allowed
  72             @param  _nCommandId
  73                 the id of the command URL
  74         */
  75         virtual void executeChecked(sal_uInt16 _nCommandId, const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue>& aArgs) = 0;
  76
  77
  78         /** checks if the given Command is enabled
  79             @param  _nCommandId
  80                 the id of the command URL
  81
  82             @return
  83                 <TRUE/> if the command is allowed, otherwise <FALSE/>.
  84         */
  85         virtual sal_Bool isCommandEnabled(sal_uInt16 _nCommandId) const = 0;
  86
  87         /** checks if the given Command is enabled
  88             @param  _rCompleteCommandURL
  89                 the URL of the command
  90
  91             @return
  92                 <TRUE/> if the command is allowed, otherwise <FALSE/>.
  93         */
  94         virtual sal_Bool isCommandEnabled( const ::rtl::OUString& _rCompleteCommandURL ) const = 0;
  95
  96         /** registers a command URL, giving it a unique name
  97
  98             If you call this with a command URL which is supported by the controller, then
  99             you will simply get the controller's internal numeric shortcut to this command.
 100
 101             If you call this with a command URL which is not supported by the controller, then
 102             you will get a new ID, which is unique during the lifetime of the controller.
 103
 104             If the command URL is invalid, or the controller cannot register new commands anymore,
 105             then 0 is returned.
 106         */
 107         virtual sal_uInt16
 108                         registerCommandURL( const ::rtl::OUString& _rCompleteCommandURL ) = 0;
 109
 110         /** notifyHiContrastChanged will be called when the hicontrast mode changed.
 111             @param  _bHiContrast
 112                 <TRUE/> when in hicontrast mode.
 113         */
 114         virtual void notifyHiContrastChanged() = 0;
 115
 116         /** checks if the selected data source is read only
 117             @return
 118                 <TRUE/> if read only, otherwise <FALSE/>
 119         */
 120         virtual sal_Bool isDataSourceReadOnly() const = 0;
 121
 122         /** provides access to the model of the controller
 123
 124             This must be the same model as returned by XController::getModel, and might be <NULL/> when
 125             the controller does not have an own model.
 126         */
 127         virtual ::com::sun::star::uno::Reference< ::com::sun::star::frame::XController >
 128                 getXController(void) throw( ::com::sun::star::uno::RuntimeException ) = 0;
 129
 130         /** allows interception of user input, aka mouse clicks and key events
 131         */
 132         virtual bool interceptUserInput( const NotifyEvent& _rEvent ) = 0;
 133
 134     protected:
 135         ~IController() {}
 136     };
 137 }
 138 #endif // DBAUI_ICONTROLLER_HXX
 139
 140 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */