sc/source/ui/inc/navsett.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: navsett.hxx,v $
  10  * $Revision: 1.4 $
  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 SC_NAVSETT_HXX
  32 #define SC_NAVSETT_HXX
  33
  34 #include <tools/solar.h>
  35
  36 #include <vector>
  37
  38 /** Contains settings of the navigator listbox. This includes the expand state
  39     of each listbox entry and the index of the selected entry and sub entry. */
  40 class ScNavigatorSettings
  41 {
  42 private:
  43     ::std::vector< BOOL >       maExpandedVec;      /// Array of Booleans for expand state.
  44     USHORT                      mnRootSelected;     /// Index of selected root entry.
  45     ULONG                       mnChildSelected;    /// Index of selected child entry.
  46
  47 public:
  48                                 ScNavigatorSettings();
  49
  50     inline void                 SetExpanded( USHORT nIndex, BOOL bExpand ) { maExpandedVec[ nIndex ] = bExpand; }
  51     inline BOOL                 IsExpanded( USHORT nIndex ) const { return maExpandedVec[ nIndex ]; }
  52
  53     inline void                 SetRootSelected( USHORT nIndex ) { mnRootSelected = nIndex; }
  54     inline USHORT               GetRootSelected() const { return mnRootSelected; }
  55
  56     inline void                 SetChildSelected( ULONG nIndex ) { mnChildSelected = nIndex; }
  57     inline ULONG                GetChildSelected() const { return mnChildSelected; }
  58 };
  59
  60
  61 #endif // SC_NAVSETT_HXX
  62