tdevelop/parts/documentation/docutils.h

/***************************************************************************
 *   Copyright (C) 2004 by Alexander Dymo                                  *
 *   cloudtemple@mksat.net                                                 *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program 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 General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.             *
 ***************************************************************************/
#ifndef DOC_UTILS_H
#define DOC_UTILS_H

#include <tqstring.h>

class KURLRequester;
class TDEPopupMenu;
class DocumentationItem;
class DocumentationPart;
class TQPoint;
class IndexItem;
class KURL;

namespace DocUtils{

/**Returns an url selected in KURLRequester but does not
resolve environment variables.*/
TQString envURL(KURLRequester *req);
/**Resolves environment variables in url.*/
TQString noEnvURL(const TQString &url);
/**Resolves environment variables in url.*/
KURL noEnvURL(const KURL &url);

void docItemPopup(DocumentationPart *part, DocumentationItem *docItem, const TQPoint &pos,
    bool showBookmark = false, bool showSearch = false, int titleCol = 0);
void docItemPopup(DocumentationPart *part, IndexItem *docItem, const TQPoint &pos,
    bool showBookmark = false, bool showSearch = false);
void docItemPopup(DocumentationPart *part, const TQString &title, const KURL &url,
    const TQPoint &pos, bool showBookmark = false, bool showSearch = false);
}

#endif