filetemplate.h

Go to the documentation of this file.

/* This file is part of the KDE project
   Copyright (C) 2002 Bernd Gehrmann <bernd@kdevelop.org>
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.
 
   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
   Library General Public License for more details.
 
   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/
 
#ifndef _FILETEMPLATE_H_
#define _FILETEMPLATE_H_
 
#include <tqstring.h>
 
class KDevPlugin;
class TQDomDocument;


class FileTemplate
{
public:
 
    typedef enum { 
        Default    ,
        Custom     
    } Policy;

    static bool exists(KDevPlugin *part, const TQString &name, Policy p = Default);
    
    static TQString read(KDevPlugin *part, const TQString &name, Policy p = Default);

    static TQString readFile(KDevPlugin *part, const TQString &fileName);

    static TQString makeSubstitutions(TQDomDocument &dom, const TQString &text);

    static bool copy(KDevPlugin *part, const TQString &name,
                     const TQString &dest, Policy p = Default);
    static TQString fullPathForName(KDevPlugin *part, const TQString &name, Policy p = Default);
};
 
#endif