diff options
author | Andre Fischer <af@openoffice.org> | 2002-09-11 12:30:12 +0000 |
---|---|---|
committer | Andre Fischer <af@openoffice.org> | 2002-09-11 12:30:12 +0000 |
commit | cec406c64d5f934baae31ca197e512a5af3b8e8f (patch) | |
tree | 67db7753434a16970c35977d4d87c72c6257d7c1 /sd/source/ui/inc/TemplateScanner.hxx | |
parent | cc17a6b7f6d8c7f1fbd13d221e8dd069f02a46e6 (diff) |
#103070# This file replaces TemplateThread.
Diffstat (limited to 'sd/source/ui/inc/TemplateScanner.hxx')
-rw-r--r-- | sd/source/ui/inc/TemplateScanner.hxx | 193 |
1 files changed, 193 insertions, 0 deletions
diff --git a/sd/source/ui/inc/TemplateScanner.hxx b/sd/source/ui/inc/TemplateScanner.hxx new file mode 100644 index 000000000000..716c8fac07af --- /dev/null +++ b/sd/source/ui/inc/TemplateScanner.hxx @@ -0,0 +1,193 @@ +/************************************************************************* + * + * $RCSfile: TemplateScanner.hxx,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: af $ $Date: 2002-09-11 13:30:12 $ + * + * 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: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ + +#ifndef _TEMPLATE_SCANNER_HXX +#define _TEMPLATE_SCANNER_HXX + +#ifndef _UCBHELPER_CONTENT_HXX +#include <ucbhelper/content.hxx> +#endif + +#ifndef _COM_SUN_STAR_FRAME_XDOCUMENTTEMPLATES_HPP_ +#include <com/sun/star/frame/XDocumentTemplates.hpp> +#endif + +#ifndef _COMPHELPER_PROCESSFACTORY_HXX_ +#include <comphelper/processfactory.hxx> +#endif + +#ifndef _COM_SUN_STAR_UCB_XCONTENTACCESS_HPP_ +#include <com/sun/star/ucb/XContentAccess.hpp> +#endif + +#ifndef _COM_SUN_STAR_SDBC_XROW_HPP_ +#include <com/sun/star/sdbc/XRow.hpp> +#endif + +#ifndef _STRING_HXX +#include <tools/string.hxx> +#endif + +#include <vector> + +namespace { +/** Representation of a template or layout file. +*/ +class TemplateEntry +{ +public: + TemplateEntry (const String& rTitle, const String& rPath) + : m_aTitle (rTitle), m_aPath (rPath) {} + + String m_aTitle; + String m_aPath; +}; + + + +/** Representation of a template or layout folder. +*/ +class TemplateDir +{ +public: + TemplateDir (const String & rRegion, const String & rUrl ) + : m_aRegion(rRegion), m_aUrl(rUrl) {} + + String m_aRegion; + String m_aUrl; + std::vector<TemplateEntry*> m_aEntries; +}; +} + + +namespace sd +{ + +/** This class scans the template folders for impress templates and puts + them into listboxes. While scanning the found templates are collected + in a local list. After completing the scan an object of this class may + be called to offer this list to transfer its contents to the caller. + Every remaining entries are deleted from the local list in the + destructor. An easy way to transfer the whole list is to call the swap + method on an STL vector with the list as argument. +*/ +class TemplateScanner +{ +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); + +protected: + /** Set the member mxTemplateRoot to the XContent that represents the + root of the template tree. + */ + void ScanFolders (void); + + /** Scan the given template folder for impress templates and insert them + into the given list. + @param rRoot + specifies the folder to search. + @param pDir + The list into which the entries for the impress templates are to + be inserted. + */ + void ScanEntries (::ucb::Content& rRoot, TemplateDir* pDir); + + /** Obtain the root folder of the template folder hierarchy. The result + is stored in mxTemplateRoot for later use. + */ + void GetTemplateRoot (void); + +private: + + /** The data structure that is to be filled with information about the + template files. + */ + std::vector<TemplateDir*> maFolderList; + + /** The root folder of the template folders. + */ + com::sun::star::uno::Reference<com::sun::star::ucb::XContent> + mxTemplateRoot; +}; + +} + +#endif |