Commit cf854607 authored by Lars Knoll's avatar Lars Knoll
Browse files

kdoc updates

svn path=/trunk/kdelibs/; revision=34363
parent 865edd0a
/* This file is part of the KDE project
Copyright (C) 1997 Martin Jones (mjones@kde.org)
(C) 1998 Waldo Bastian (bastian@kde.org)
(C) 1998, 1999 Torben Weis (weis@kde.org)
(C) 1999 Lars Knoll (knoll@kde.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., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
/**
* @libdoc KDE HTML widget
*
* This library provides a full-featured HTML parser and widget. It is
* used for rendering in all KDE applications which allow HTML viewing,
* including the Konqueror browser/file manager and the KDE Help
* system.
*
* This library provides (will provide)
* full HTML4 support, support for embedding Java applets, and will at some
* point (hopefully before KDE-2.0 provide support for cascading style sheets
* (CSS) and JavaScript.
*
* If you want to add to your application a widget that oly needs simple text
* browsing, you can also use the @ref KTextBrowser widget in kdeui.
*
* @ref KHTMLWidget :
* The main widget for using khtml.
*
* @ref DOM :
* The dom implementation used in khtml.
*
*/
/**
*
* The Document Object Model (DOM) is divided into two parts, the
* @ref COREDOM core
* DOM, specifying some core functionality, and the @ref HTMLDOM HTML DOM,
* which deals with the extensions needed for HTML.
*
*
*/
namespace DOM
{
};
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......@@ -37,6 +37,9 @@ class TextImpl;
class AttrImpl;
class NodeListImpl;
/**
* @internal
*/
class DocumentImpl : public NodeBaseImpl
{
public:
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* Copyright (C) 1997 Martin Jones (mjones@kde.org)
......
......@@ -896,25 +896,5 @@ private:
static QPixmap* paintBuffer;
};
/**
* @libdoc KDE HTML widget
*
* This library provides a full-featured HTML parser and widget. It is
* used for rendering in all KDE applications which allow HTML viewing,
* including the Konqueror browser/file manager and the KDE Help
* system.
*
* This library provides (will provide)
* full HTML4 support, support for embedding Java applets, and will at some
* point (hopefully before KDE-2.0 provide support for cascading style sheets
* (CSS) and JavaScript.
*
* If you want to add to your application a widget that oly needs simple text
* browsing, you can also use the @ref KTextBrowser widget in kdeui.
*
* @see KHTMLWidget, KTextBrowser
*/
#endif
......@@ -37,6 +37,9 @@
#define MAXFONTSIZES 7
#endif
/**
* @internal
*/
class HTMLSettings
{
public:
......@@ -72,3 +75,5 @@ extern HTMLSettings* pSettings;
#endif
......@@ -17,17 +17,17 @@
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
//----------------------------------------------------------------------------
//
// KDE HTML Widget -- decoder for input stream
// $Id$
$Id$
*/
#ifndef KHTMLDECODER_H
#define KHTMLDECODER_H
#include <qtextcodec.h>
/**
* @internal
*/
class KHTMLDecoder
{
public:
......
......@@ -38,6 +38,10 @@
#define MAXFONTSIZES 7
#endif
/**
* @internal
* This class represents the fonr used during html rendering.
*/
class HTMLFont
{
public:
......@@ -143,6 +147,10 @@ inline bool HTMLFont::operator==( const HTMLFont& f )
//-----------------------------------------------------------------------------
/**
* @internal
* manages a list of already loaded @ref HTMLFont's.
*/
class HTMLFontManager
{
public:
......
......@@ -49,6 +49,9 @@ class QMovie;
class KHTMLWidget;
/**
* @internal
*/
class HTMLURLRequester
{
public:
......@@ -64,6 +67,9 @@ public:
bool /* eof */ = false ) = 0;
};
/**
* @internal
*/
class HTMLImageRequester
{
public:
......@@ -71,6 +77,9 @@ public:
virtual void pixmapChanged( QPixmap *p ) = 0;
};
/**
* @internal
*/
struct HTMLURLRequest
{
public:
......@@ -82,6 +91,9 @@ public:
QList<HTMLURLRequester> m_lstClients;
};
/**
* @internal
*/
class HTMLURLRequestJob : QObject
{
Q_OBJECT
......@@ -107,14 +119,8 @@ protected:
struct HTMLPageInfo
{
public:
QStringList imageURLs;
QStringList hrefURLs;
};
/**
* @internal
* Defines the DataSource for incremental loading of images.
*/
class KHTMLImageSource : public QDataSource
......@@ -163,6 +169,7 @@ class KHTMLImageSource : public QDataSource
};
/**
* @internal
* contains one cached image
*/
class KHTMLCachedImage : public QObject
......@@ -230,6 +237,9 @@ private:
KHTMLImageSource* imgSource;
};
/**
* @internal
*/
class ImageList : public QStringList
{
public:
......@@ -244,6 +254,9 @@ public:
}
};
/**
* @internal
*/
class KHTMLCache : public HTMLURLRequester
{
public:
......
......@@ -180,7 +180,9 @@ const unsigned short tagPriority[] = {
0, // ID_TEXT
};
/*
/**
* @internal
*
* The parser parses tokenized input into the document, building up the
* document tree. If the document is wellformed, parsing it is
* straightforward.
......
......@@ -41,6 +41,7 @@ class KHTMLParser;
namespace DOM {
class NodeImpl;
};
//
// Internal Classes
//
......@@ -58,6 +59,9 @@ void setNamedColor(QColor &color, const QString name);
typedef void (KHTMLParser::*blockFunc)(HTMLStackElem *stackElem);
/**
* @internal
*/
class HTMLStackElem
{
public:
......@@ -92,6 +96,9 @@ public:
HTMLStackElem *next;
};
/**
* @internal
*/
class CSSStyleFont
{
public:
......@@ -110,6 +117,9 @@ public:
const HTMLFont *fp;
};
/**
* @internal
*/
class CSSStyleText
{
public:
......@@ -130,6 +140,9 @@ public:
int heightValue; // the scaling factor or fixed height
};
/**
* @internal
*/
class CSSStyleBox
{
public:
......@@ -145,6 +158,9 @@ public:
int borderStyle;
};
/**
* @internal
*/
class CSSStyleList
{
public:
......@@ -155,6 +171,9 @@ public:
};
/**
* @internal
*/
class CSSStyle
{
public:
......@@ -181,6 +200,9 @@ class CSSSelector;
typedef QList<CSSSelector> CSSSelecList;
/**
* @internal
*/
class CSSStyleSheet
{
......
/**
/*
* This file is part of the DOM implementation for KDE.
*
* (C) 1999 Lars Knoll (knoll@kde.org)
......
......@@ -34,6 +34,10 @@
#include "khtmlstring.h"
#include "dom_stringimpl.h"
/**
* @internal
* represents one HTML Attribute
*/
class Attribute
{
public:
......@@ -98,9 +102,13 @@ public:
ushort id;
protected:
DOMStringImpl *v;
DOM::DOMStringImpl *v;
};
/**
* @internal
* A list of Attributes
*/
class AttributeList
{
......@@ -142,6 +150,12 @@ protected:
};
/**
* @internal
* represents one HTML tag. Consists of a numerical id, and the list
* of attributes. Can also represent text. In this case the id = 0 and
* text contains the text.
*/