svx/source/outliner/paralist.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: paralist.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 _PARALIST_HXX
  32 #define _PARALIST_HXX
  33
  34 class Paragraph;
  35
  36 #include <tools/list.hxx>
  37 #include <tools/link.hxx>
  38
  39 class ParagraphList : private List
  40 {
  41 private:
  42     Link                        aVisibleStateChangedHdl;
  43
  44 public:
  45     void                        Clear( BOOL bDestroyParagraphs );
  46
  47     ULONG                       GetParagraphCount() const                       { return List::Count(); }
  48     Paragraph*          GetParagraph( ULONG nPos ) const        { return (Paragraph*)List::GetObject( nPos ); }
  49
  50     ULONG                       GetAbsPos( Paragraph* pParent ) const { return List::GetPos( pParent ); }
  51     ULONG                       GetVisPos( Paragraph* pParagraph );
  52
  53     void                        Insert( Paragraph* pPara, ULONG nAbsPos = LIST_APPEND ) { List::Insert( pPara, nAbsPos ); }
  54     void                        Remove( ULONG nPara ) { List::Remove( nPara ); }
  55     void                        MoveParagraphs( ULONG nStart, ULONG nDest, ULONG nCount );
  56
  57     Paragraph*          NextVisible( Paragraph* ) const;
  58     Paragraph*          PrevVisible( Paragraph* ) const;
  59     Paragraph*          LastVisible() const;
  60
  61     Paragraph*          GetParent( Paragraph* pParagraph /*, USHORT& rRelPos */ ) const;
  62     BOOL                        HasChilds( Paragraph* pParagraph ) const;
  63     BOOL                        HasHiddenChilds( Paragraph* pParagraph ) const;
  64     BOOL                        HasVisibleChilds( Paragraph* pParagraph ) const;
  65     ULONG                       GetChildCount( Paragraph* pParagraph ) const;
  66
  67     void            Expand( Paragraph* pParent );
  68     void            Collapse( Paragraph* pParent );
  69
  70     void                        SetVisibleStateChangedHdl( const Link& rLink ) { aVisibleStateChangedHdl = rLink; }
  71     Link                        GetVisibleStateChangedHdl() const { return aVisibleStateChangedHdl; }
  72 };
  73
  74 #endif