ef91ddebf3
2006/03/24 12:59:54 af 1.4.116.3: #i61115# Replaced auto_ptr by scoped_ptr. 2006/03/24 10:56:23 af 1.4.116.2: #i61115# Ordering template folders so that user supplied templates come first. 2006/02/17 12:53:24 af 1.4.116.1: #i61359# Added support for the AsynchronousTask interface.
240 lines
7.3 KiB
C++
240 lines
7.3 KiB
C++
/*************************************************************************
|
|
*
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
|
*
|
|
* $RCSfile: TemplateScanner.hxx,v $
|
|
*
|
|
* $Revision: 1.5 $
|
|
*
|
|
* last change: $Author: kz $ $Date: 2006-04-26 20:46:11 $
|
|
*
|
|
* The Contents of this file are made available subject to
|
|
* the terms of GNU Lesser General Public License Version 2.1.
|
|
*
|
|
*
|
|
* GNU Lesser General Public License Version 2.1
|
|
* =============================================
|
|
* Copyright 2005 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
|
|
*
|
|
************************************************************************/
|
|
|
|
#ifndef _TEMPLATE_SCANNER_HXX
|
|
#define _TEMPLATE_SCANNER_HXX
|
|
|
|
#include "tools/AsynchronousTask.hxx"
|
|
|
|
#ifndef INCLUDED_SDDLLAPI_H
|
|
#include "sddllapi.h"
|
|
#endif
|
|
|
|
#ifndef _UCBHELPER_CONTENT_HXX
|
|
#include <ucbhelper/content.hxx>
|
|
#endif
|
|
#ifndef _STRING_HXX
|
|
#include <tools/string.hxx>
|
|
#endif
|
|
|
|
#ifndef _COM_SUN_STAR_UNO_REFERENCE_HXX_
|
|
#include "com/sun/star/uno/Reference.hxx"
|
|
#endif
|
|
|
|
#include <vector>
|
|
#include <boost/scoped_ptr.hpp>
|
|
|
|
namespace com { namespace sun { namespace star { namespace ucb {
|
|
class XContent;
|
|
class XCommandEnvironment;
|
|
} } } }
|
|
|
|
namespace com { namespace sun { namespace star { namespace sdbc {
|
|
class XResultSet;
|
|
} } } }
|
|
|
|
namespace sd {
|
|
|
|
/** Representation of a template or layout file.
|
|
*/
|
|
class TemplateEntry
|
|
{
|
|
public:
|
|
TemplateEntry (const String& rsTitle, const String& rsPath)
|
|
: msTitle(rsTitle), msPath(rsPath) {}
|
|
|
|
String msTitle;
|
|
String msPath;
|
|
};
|
|
|
|
|
|
|
|
|
|
/** Representation of a template or layout folder.
|
|
*/
|
|
class TemplateDir
|
|
{
|
|
public:
|
|
TemplateDir (const String& rsRegion, const String& rsUrl )
|
|
: msRegion(rsRegion), msUrl(rsUrl), maEntries() {}
|
|
|
|
String msRegion;
|
|
String msUrl;
|
|
::std::vector<TemplateEntry*> maEntries;
|
|
};
|
|
|
|
|
|
|
|
|
|
/** This class scans the template folders for impress templates. There are
|
|
two ways to use this class.
|
|
1. The old and deprecated way is to call Scan() to scan all templates
|
|
and collect the supported ones in a tree structure. This structure is
|
|
returned by GetFolderList().
|
|
2. The new way implements the AsynchronousTask interface. Call
|
|
RunNextStep() as long HasNextStep() returns <TRUE/>. After every step
|
|
GetLastAddedEntry() returns the template that was scanned (and has a
|
|
supported format) last. When a step does not add a new template then
|
|
the value of the previous step is returned.
|
|
*/
|
|
class SD_DLLPUBLIC TemplateScanner
|
|
: public ::sd::tools::AsynchronousTask
|
|
{
|
|
public:
|
|
/** Create a new template scanner and prepare but do not execute the scanning.
|
|
*/
|
|
TemplateScanner (void);
|
|
|
|
/** The destructor deletes any remaining entries of the local list of
|
|
templates.
|
|
*/
|
|
virtual ~TemplateScanner (void);
|
|
|
|
/** Execute the actual scanning of templates. When this method
|
|
terminates the result can be obtained by calling the
|
|
<member>GetTemplateList</member> method.
|
|
*/
|
|
void Scan (void);
|
|
|
|
/** Return the list of template folders. It lies in the responsibility
|
|
of the caller to take ownership of some or all entries and remove
|
|
them from the returned list. All entries that remain until the
|
|
destructor is called will be destroyed.
|
|
*/
|
|
std::vector<TemplateDir*>& GetFolderList (void);
|
|
|
|
/** Implementation of the AsynchronousTask interface method.
|
|
*/
|
|
virtual void RunNextStep (void);
|
|
|
|
/** Implementation of the AsynchronousTask interface method.
|
|
*/
|
|
virtual bool HasNextStep (void);
|
|
|
|
/** Return the TemplateDir object that was last added to
|
|
mpTemplateDirectory.
|
|
@return
|
|
<NULL/> is returned either before the template scanning is
|
|
started or after it has ended.
|
|
*/
|
|
const TemplateEntry* GetLastAddedEntry (void) const;
|
|
|
|
private:
|
|
/** The current state determines which step will be executed next by
|
|
RunNextStep().
|
|
*/
|
|
enum State {
|
|
INITIALIZE_SCANNING,
|
|
INITIALIZE_FOLDER_SCANNING,
|
|
GATHER_FOLDER_LIST,
|
|
SCAN_FOLDER,
|
|
INITIALIZE_ENTRY_SCAN,
|
|
SCAN_ENTRY,
|
|
DONE,
|
|
ERROR
|
|
};
|
|
State meState;
|
|
|
|
::ucb::Content maFolderContent;
|
|
TemplateDir* mpTemplateDirectory;
|
|
|
|
/** The data structure that is to be filled with information about the
|
|
template files.
|
|
*/
|
|
std::vector<TemplateDir*> maFolderList;
|
|
|
|
/** This member points into the maFolderList to the member that was most
|
|
recently added.
|
|
*/
|
|
TemplateEntry* mpLastAddedEntry;
|
|
|
|
/** The folders that are collected by GatherFolderList().
|
|
*/
|
|
class FolderDescriptorList;
|
|
::boost::scoped_ptr<FolderDescriptorList> mpFolderDescriptors;
|
|
|
|
/** Set of state variables used by the methods
|
|
InitializeFolderScanning(), GatherFolderList(), ScanFolder(),
|
|
InitializeEntryScanning(), and ScanEntry().
|
|
*/
|
|
com::sun::star::uno::Reference<com::sun::star::ucb::XContent> mxTemplateRoot;
|
|
com::sun::star::uno::Reference<com::sun::star::ucb::XCommandEnvironment> mxFolderEnvironment;
|
|
com::sun::star::uno::Reference<com::sun::star::ucb::XCommandEnvironment> mxEntryEnvironment;
|
|
com::sun::star::uno::Reference<com::sun::star::sdbc::XResultSet> mxFolderResultSet;
|
|
com::sun::star::uno::Reference<com::sun::star::sdbc::XResultSet> mxEntryResultSet;
|
|
|
|
/** Obtain the root folder of the template folder hierarchy. The result
|
|
is stored in mxTemplateRoot for later use.
|
|
*/
|
|
State GetTemplateRoot (void);
|
|
|
|
/** Initialize the scanning of folders. This is called exactly once.
|
|
@return
|
|
Returns one of the two states ERROR or GATHER_FOLDER_LIST.
|
|
*/
|
|
State InitializeFolderScanning (void);
|
|
|
|
/** Collect all available top-level folders in an ordered list which can
|
|
then be processed by ScanFolder().
|
|
@return
|
|
Returns one of the two states ERROR or SCAN_FOLDER.
|
|
*/
|
|
State GatherFolderList (void);
|
|
|
|
/** From the list of top-level folders collected by GatherFolderList()
|
|
the one with highest priority is processed.
|
|
@return
|
|
Returns one of the states ERROR, DONE, or INITILIZE_ENTRY_SCAN.
|
|
*/
|
|
State ScanFolder (void);
|
|
|
|
/** Initialize the scanning of entries of a top-level folder.
|
|
@return
|
|
Returns one of the states ERROR or SCAN_ENTRY.
|
|
*/
|
|
State InitializeEntryScanning (void);
|
|
|
|
/** Scan one entry. When this entry matches the recognized template
|
|
types it is appended to the result set.
|
|
@return
|
|
Returns one of the states ERROR, SCAN_ENTRY, or SCAN_FOLDER.
|
|
*/
|
|
State ScanEntry (void);
|
|
};
|
|
|
|
} // end of namespace sd
|
|
|
|
#endif
|