Line data    Source code

       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_SVTOOLS_TABLE_TABLEINPUTHANDLER_HXX
      21             : #define INCLUDED_SVTOOLS_TABLE_TABLEINPUTHANDLER_HXX
      22             : 
      23             : #include <memory>
      24             : 
      25             : class MouseEvent;
      26             : class KeyEvent;
      27             : class HelpEvent;
      28             : class CommandEvent;
      29             : class NotifyEvent;
      30             : 
      31             : 
      32             : namespace svt { namespace table
      33             : {
      34             : 
      35             : 
      36             :     class ITableControl;
      37             : 
      38             : 
      39             :     //= ITableInputHandler
      40             : 
      41             :     /** interface for components handling input in a ->TableControl
      42             :     */
      43           2 :     class ITableInputHandler
      44             :     {
      45             :     public:
      46             :         // all those methods have the same semantics as the equal-named methods of ->Window,
      47             :         // with the additional option to return a boolean value indicating whether
      48             :         // the event should be further processed by the ->Window implementations (<FALSE/>),
      49             :         // or whether it has been sufficiently handled by the ->ITableInputHandler instance
      50             :         // (<FALSE/>).
      51             : 
      52             :         virtual bool    MouseMove       ( ITableControl& _rControl, const MouseEvent& rMEvt ) = 0;
      53             :         virtual bool    MouseButtonDown ( ITableControl& _rControl, const MouseEvent& rMEvt ) = 0;
      54             :         virtual bool    MouseButtonUp   ( ITableControl& _rControl, const MouseEvent& rMEvt ) = 0;
      55             :         virtual bool    KeyInput        ( ITableControl& _rControl, const KeyEvent& rKEvt ) = 0;
      56             :         virtual bool    GetFocus        ( ITableControl& _rControl ) = 0;
      57             :         virtual bool    LoseFocus       ( ITableControl& _rControl ) = 0;
      58             :         virtual bool    RequestHelp     ( ITableControl& _rControl, const HelpEvent& rHEvt ) = 0;
      59             :         virtual bool    Command         ( ITableControl& _rControl, const CommandEvent& rCEvt ) = 0;
      60             :         virtual bool    PreNotify       ( ITableControl& _rControl, NotifyEvent& rNEvt ) = 0;
      61             :         virtual bool    Notify          ( ITableControl& _rControl, NotifyEvent& rNEvt ) = 0;
      62             : 
      63           2 :         virtual ~ITableInputHandler() { }
      64             :     };
      65             :     typedef std::shared_ptr< ITableInputHandler >   PTableInputHandler;
      66             : 
      67             : 
      68             : } } // namespace svt::table
      69             : 
      70             : 
      71             : #endif // INCLUDED_SVTOOLS_TABLE_TABLEINPUTHANDLER_HXX
      72             : 
      73             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */