/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: IBM Corporation
 *
 *  Copyright: 2008 by IBM Corporation
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
/*************************************************************************
 * @file
 * Base list object.
 ************************************************************************/
/*************************************************************************
 * Change History
 * 2005-01-17 create this file.
 ************************************************************************/
#ifndef		_XFLIST_HXX
#define		_XFLIST_HXX

#include	"xflistitem.hxx"
#include	"xfcontentcontainer.hxx"

class XFListItem;

/**
 * @brief
 * list obejct for order-list and unordered-list.
 */
class	XFList : public XFContentContainer
{
public:
    XFList();

    XFList(sal_Bool ordered);

    virtual ~XFList();

public:
    /**
     * @descr	Set whether it's an ordered list or an unordered list.
     */
    void	SetOrdered(sal_Bool ordered);

    /**
     * @descr	Set whether to continue to number list.
     */
    void	SetContinueNumber(sal_Bool bContinueNumber=sal_False);

    /**
     * @descr	Add a list item.
     */
    void	AddItem(XFListItem *pItem);

    /**
     * @descr	Add a simple text list item.
     */
    void	AddItem(rtl::OUString text);

    /**
     * @descr	Set the header list item. There can only be one list header.
     */
    void	SetHeader(XFListItem *pItem);

    /**
     * @descr	Output list obejct.
     */
    virtual void	ToXml(IXFStream *pStrm);

    virtual void	StartList(IXFStream *pStrm, sal_Bool bContinueNumber = sal_False);

    virtual void	EndList(IXFStream *pStrm);

    static void		StartListHeader(IXFStream *pStrm);

    static void		EndListHeader(IXFStream *pStrm);

    static void		StartListItem(IXFStream *pStrm);

    static void		EndListItem(IXFStream *pStrm);

private:
    sal_Bool	m_bOrdered;
    sal_Bool	m_bContinueNumber;
    XFListItem	*m_pHeader;

};

class XFUnorderedList : public XFList
{
public:
    XFUnorderedList()
    {
        SetOrdered(sal_False);
    }
};

class XFOrderedList : public XFList
{
public:
    XFOrderedList()
    {
        SetOrdered(sal_True);
    }
};

inline void XFList::SetOrdered(sal_Bool ordered)
{
    m_bOrdered = ordered;
}

inline void XFList::SetContinueNumber(sal_Bool bContinueNumber)
{
    m_bContinueNumber = bContinueNumber;
}

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
