[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-kafka
Subject:    Kafka Rewrite Status 1/20
From:       Nikolas Zimmermann <wildfox () kde ! org>
Date:       2001-07-12 13:52:58
[Download RAW message or body]

Hi guys,

i want to get this rewrite done very quick :)
There are 20 mails to go.
This is the first.
With the 20th mail, I'll check in my stuff.


Mail 1:
----------
1. KafkaHTMLPart rewritten.
2. KafkaPart added (ReadWritePart - The Part)
3. Kafka added (KParts::MainWindow - The Shell)
...

class KafkaHTMLPart : public KHTMLPart
{
Q_OBJECT
public:
        KafkaHTMLPart(QWidget *parent, const char *name);
        ~KafkaHTMLPart();

        /**
         * Category: Standard Functions
         * Called by KafkaPart to create a new document
         */
        void newDocument();

        /**
         * Category: Standard Functions
         * Called by KafkaPart to open a document
         * @param url Specifies the URL to open
         * @return Returns true if it worked, else false
         */
        bool openDocument(const KURL &url);

        /**
         * Category: Standard Functions
         * Called by KafkaPart to save the current document
         * @param url Specifies the URL to save to
         * @return Returns true if it worked, else false
         */
        bool saveDocument(const KURL &url);

        /**
         * Category: Standard Function
         * Called by KafkaPart to set the readonly variable
         * @param value Specifies wheter we accept keyboard input or not
         */
        void setReadOnly(bool value) { m_readOnly = value; }

        /**
         * Category: Standard Functions
         * Is the KafkaHTMLPart ReadOnly?
         * @return Return wheter the part is writeable or not
         */
        bool readOnly() { return m_readOnly; }

public slots:
        /**
         * Category: HTML Editing Functions
         * Inserts a DOM::Element into the DOM::Document, after or before the 
panode
         * @param element The element to add into the document
         * @param paelement The element before/after element
         * @param insertBefore Specifies wheter to add element before panode 
or after panode
         * @return Returns true if it worked, else false
         */
        bool insertElement(DOM::Element element, DOM::Node panode, bool 
insertBefore);

        /**
         * Category: HTML Editing Functions
         * Inserts a DOM::Element into the DOM::Document, after or before the 
current DOM::Node
         * @param node The element to add into the document
         * @param insertBefore Specifies wheter to add element before the 
current node
         * or after the current node
         * @return Returns true if it worked, else false
         */
        bool insertElement(DOM::Element node, bool insertBefore);

        /**
         * Category: HTML Editing Functions
         * Removes a DOM::Element from the DOM::Document
         * @param element The element to remove from the document
         * @retun Returns true if it worked, else false
         */
        bool removeElement(DOM::Element element);
 
        /**
         * Category: HTML Editing Functions
         * Adds text into a DOM::Node of type DOM::Node::TEXT_NODE
         * @param node The node where text should be added
         * @param text The text to be added
         * @param position Specifies the position where to add text
         */
        void insertText(DOM::Node node, const QString &text, int posit
 
        /**
         * Category: HTML Editing Functions
         * Adds text into the current DOM::Node
         * @param text The text to add
         * @param position Specifies the position where to add text, i
         * the text will be appended after the last position
         */
        void insertText(const QString &text, int position);
 
        /**
         * Category: HTML Editing Functions
         * Moves the cursor x-characters to the left
         * @param value Specifies the charachters to move to the left
         */
        void nextOffset(int value);
 
        /**
         * Category: HTML Editing Functions
         * Moves the cursor x-characters to the right
         * @param value Specifies the charachters to move to the right
         */
        void previousOffset(int value);
 
signals:
        /**
         * Category: HTML Editing Signal
         * Is emitted whenever the DOM tree has changed
         */
        void domChanged();
 
protected:
        bool eventFilter(QObject *object, QEvent *event);
 
private:
        DOM::Node m_currentNode;
        bool m_readOnly;
        int m_cursorOffset;
 
};

That's what it gives the developer, so far.
It#s not yet finished, not all functions are added so far.

Do you like this way of documentating?

Comments?

Bye
 Bye
  Niko

-- 
Nikolas Zimmermann
wildfox@kde.org
_______________________________________________
Kde-kafka mailing list
Kde-kafka@master.kde.org
http://master.kde.org/mailman/listinfo/kde-kafka

[prev in list] [next in list] [prev in thread] [next in thread]