forms/source/solar/inc/navtoolbar.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: navtoolbar.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
  31 #ifndef FORMS_SOLAR_CONTROL_NAVTOOLBAR_HXX
  32 #define FORMS_SOLAR_CONTROL_NAVTOOLBAR_HXX
  33
  34 #include <vcl/toolbox.hxx>
  35 #include <vcl/field.hxx>
  36
  37 //.........................................................................
  38 namespace frm
  39 {
  40 //.........................................................................
  41
  42     class IFeatureDispatcher;
  43
  44     class ImplNavToolBar;
  45     //=====================================================================
  46     //= NavigationToolBar
  47     //=====================================================================
  48     class NavigationToolBar : public Window
  49     {
  50     public:
  51         enum ImageSize
  52         {
  53             eSmall,
  54             eLarge
  55         };
  56
  57         enum FunctionGroup
  58         {
  59             ePosition,
  60             eNavigation,
  61             eRecordActions,
  62             eFilterSort
  63         };
  64
  65     private:
  66         const IFeatureDispatcher*   m_pDispatcher;
  67         ImageSize                   m_eImageSize;
  68         ImplNavToolBar*             m_pToolbar;
  69         ::std::vector< Window* >    m_aChildWins;
  70
  71     public:
  72         NavigationToolBar( Window* _pParent, WinBits _nStyle );
  73         ~NavigationToolBar( );
  74
  75         /** sets the dispatcher which is to be used for the features
  76
  77             If the dispatcher is the same as the one which is currently set,
  78             then the states of the features are updated
  79
  80             @param _pDispatcher
  81                 the new (or old) dispatcher. The caller is reponsible for
  82                 ensuring the life time of the object does exceed the life time
  83                 of the tool bar instance.
  84         */
  85         void                        setDispatcher( const IFeatureDispatcher* _pDispatcher );
  86
  87         /** enables or disables a given feature
  88         */
  89         void                        enableFeature( sal_Int32 _nFeatureId, bool _bEnabled );
  90
  91         /** checks or unchecks a given feature
  92         */
  93         void                        checkFeature( sal_Int32 _nFeatureId, bool _bEnabled );
  94
  95         /** sets the text of a given feature
  96         */
  97         void                        setFeatureText( sal_Int32 _nFeatureId, const ::rtl::OUString& _rText );
  98
  99         /** retrieves the current image size
 100         */
 101         inline ImageSize    GetImageSize( ) const { return m_eImageSize; }
 102
 103         /** sets the size of the images
 104         */
 105         void                SetImageSize( ImageSize _eSize );
 106
 107         /** shows or hides a function group
 108         */
 109         void                ShowFunctionGroup( FunctionGroup _eGroup, bool _bShow );
 110
 111         /** determines whether or not a given function group is currently visible
 112         */
 113         bool                IsFunctionGroupVisible( FunctionGroup _eGroup );
 114
 115         // Window "overridables" (hiding the respective Window methods)
 116         void                SetControlBackground();
 117         void                SetControlBackground( const Color& rColor );
 118         void                SetTextLineColor( );
 119         void                SetTextLineColor( const Color& rColor );
 120
 121     protected:
 122         // Window overridables
 123         virtual void        Resize();
 124         virtual void        StateChanged( StateChangedType nType );
 125
 126         /// ctor implementation
 127         void implInit( );
 128
 129         /// impl version of SetImageSize
 130         void    implSetImageSize( ImageSize _eSize, bool _bForce = false );
 131
 132         /// enables or disables an item, plus possible dependent items
 133         void implEnableItem( USHORT _nItemId, bool _bEnabled );
 134
 135         /** update the states of all features, using the callback
 136         */
 137         void updateFeatureStates( );
 138
 139         // iterating through item windows
 140         typedef void (NavigationToolBar::*ItemWindowHandler) (USHORT, Window*, const void*) const;
 141         void    forEachItemWindow( ItemWindowHandler _handler, const void* _pParam );
 142
 143         void setItemBackground( USHORT /* _nItemId */, Window* _pItemWindow, const void* _pColor ) const;
 144         void setTextLineColor( USHORT /* _nItemId */, Window* _pItemWindow, const void* _pColor ) const;
 145 #if 0
 146         void setItemWindowZoom( USHORT /* _nItemId */, Window* _pItemWindow, const void* /* _pParam */ ) const;
 147 #endif
 148         void setItemControlFont( USHORT /* _nItemId */, Window* _pItemWindow, const void* /* _pParam */ ) const;
 149         void setItemControlForeground( USHORT /* _nItemId */, Window* _pItemWindow, const void* /* _pParam */ ) const;
 150         void adjustItemWindowWidth( USHORT _nItemId, Window* _pItemWindow, const void* /* _pParam */ ) const;
 151         void enableItemRTL( USHORT /*_nItemId*/, Window* _pItemWindow, const void* _pIsRTLEnabled ) const;
 152     };
 153
 154     //=====================================================================
 155     //= RecordPositionInput
 156     //=====================================================================
 157     class RecordPositionInput : public NumericField
 158     {
 159     private:
 160         const IFeatureDispatcher*   m_pDispatcher;
 161
 162     public:
 163         RecordPositionInput( Window* _pParent );
 164         ~RecordPositionInput();
 165
 166         /** sets the dispatcher which is to be used for the features
 167         */
 168         void    setDispatcher( const IFeatureDispatcher* _pDispatcher );
 169
 170     protected:
 171         // Window overridables
 172         virtual void LoseFocus();
 173         virtual void KeyInput( const KeyEvent& rKeyEvent );
 174
 175     private:
 176         void FirePosition( sal_Bool _bForce );
 177     };
 178
 179 //.........................................................................
 180 }   // namespace frm
 181 //.........................................................................
 182
 183 #endif // FORMS_SOLAR_CONTROL_NAVTOOLBAR_HXX