dbaccess/source/ui/inc/ScrollHelper.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ScrollHelper.hxx,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef DBAUI_SCROLLHELPER_HXX
  31 #define DBAUI_SCROLLHELPER_HXX
  32
  33 #ifndef _LINK_HXX
  34 #include <tools/link.hxx>
  35 #endif
  36 #ifndef _SV_GEN_HXX
  37 #include <tools/gen.hxx>
  38 #endif
  39 #ifndef _SV_TIMER_HXX
  40 #include <vcl/timer.hxx>
  41 #endif
  42
  43 namespace dbaui
  44 {
  45     class OScrollHelper
  46     {
  47         Link    m_aUpScroll;
  48         Link    m_aDownScroll;
  49     public:
  50         /** default contructor
  51         */
  52         OScrollHelper();
  53
  54         ~OScrollHelper();
  55
  56         /** set the memthod which should be called when scrolling up
  57             @param      _rUpScroll
  58                 the method to set
  59         */
  60         inline void setUpScrollMethod( const Link& _rUpScroll )
  61         {
  62             m_aUpScroll = _rUpScroll;
  63         }
  64
  65         /** set the memthod which should be called when scrolling down
  66             @param      _rDownScroll
  67                 the method to set
  68         */
  69         inline void setDownScrollMethod( const Link& _rDownScroll )
  70         {
  71             m_aDownScroll = _rDownScroll;
  72         }
  73
  74         /** check if a scroll method has to be called
  75             @param      _rPoint
  76                 the current selection point
  77             @param      _rOutputSize
  78                 the output size of the window
  79         */
  80         void scroll(const Point& _rPoint, const Size& _rOutputSize);
  81     };
  82 }
  83 #endif // DBAUI_SCROLLHELPER_HXX
  84