diff options
Diffstat (limited to 'quanta/parts/kafka/kafkacommon.h')
-rw-r--r-- | quanta/parts/kafka/kafkacommon.h | 116 |
1 files changed, 58 insertions, 58 deletions
diff --git a/quanta/parts/kafka/kafkacommon.h b/quanta/parts/kafka/kafkacommon.h index fdec2aef..c3d76488 100644 --- a/quanta/parts/kafka/kafkacommon.h +++ b/quanta/parts/kafka/kafkacommon.h @@ -58,7 +58,7 @@ public: /** * This function returns the next Node after node : the first child of * node if available, else its next sibling if available, else the next - * available next sibling of a tqparent of node. + * available next sibling of a parent of node. * @param _node It is the Node from which we want the next Node. * @param goUp This boolean specifies if we should go up (torwards the root Node) * i.e. not looking at the childs of node, or make a standart iteration. @@ -87,20 +87,20 @@ public: /** - * Returns the first common tqparent to startNode and endNode that isn't inline. + * Returns the first common parent to startNode and endNode that isn't inline. * @param startNode Start node. * @param endNode End node. - * @param commonParentStartChildLocation Is the child of commonParent which is tqparent of startNode - * @param commonParentEndChildLocation Is the child of commonParent which is tqparent of endNode + * @param commonParentStartChildLocation Is the child of commonParent which is parent of startNode + * @param commonParentEndChildLocation Is the child of commonParent which is parent of endNode * @param nodeSubtree When startNode and endNode doesn't belong to the current document tree. Pass 0 if they do. - * @return The first, non inline, common tqparent of startNode and endNode. + * @return The first, non inline, common parent of startNode and endNode. */ static Node* DTDGetNonInlineCommonParent(Node* startNode, Node* endNode, TQValueList<int>& commonParentStartChildLocation, TQValueList<int>& commonParentEndChildLocation, Node* nodeSubtree); /** - * Same as above, only that the common tqparent can be inline. + * Same as above, only that the common parent can be inline. */ static Node* DTDGetCommonParent(Node* startNode, Node* endNode, TQValueList<int>& commonParentStartChildLocation, @@ -109,14 +109,14 @@ public: /** * This function returns the next DOM::Node after node : the first child of * DOM::Node if available, else its next sibling if available, else the next - * available next sibling of a tqparent of node. + * available next sibling of a parent of node. * @param node The DOM::Node the search starts from. * @param goUp This boolean specifies if we should go up or down in the tree. * For a normal use, It must be set to false at the * beginning and then the same boolean must be used when using * several times this function. * @param returnParentNode Specifies if there are no child and next sibling, if - * we should return the tqparent. + * we should return the parent. * @param endNode Specifies at which DOM::Node the search should end. It is useful * when setting returnParentNode to false. * @return the next Node. @@ -153,7 +153,7 @@ public: static Node* getCorrectEndNode(Node* endNode, int& endOffset); /** - * Get the first child of commonParent which is tqparent of node + * Get the first child of commonParent which is parent of node * @param node * @param commonParent * @return @@ -186,7 +186,7 @@ public: * generated by the undoRedo system. The undoRedo system can't create itself these Nodes * because it will create them only during the synchronization, making all the TQValueList<int> * Nodes location wrong. - * WARNING n1 and n2 must be siblings or tqparent-child. If there are sibling and n1 is a XmlTag, + * WARNING n1 and n2 must be siblings or parent-child. If there are sibling and n1 is a XmlTag, * n1 should not have non empty childs. * @param n1 The start node. * @param n2 The end node. @@ -290,7 +290,7 @@ public: * WARNING : baseNode is used as the rootNode. * It will also try to merge text/Empty Nodes. * @param node The node to insert. - * @param parentNode This Node will be the tqparent of node. + * @param parentNode This Node will be the parent of node. * @param nextSibling This Node will be the next Sibling of Node. If null, node will be appended at * the child list of parentNode. * TODO: @param rootNode The rootNode of the tree we want to insert the Node (usually &baseNode). @@ -308,11 +308,11 @@ public: /** * It behaves essentially like the above function except that it can "surround" a set of Nodes with the * new Node. Thus, the closing Node is created if necessary. - * nextSibling and nextEndSibling MUST have the same tqparent. If not, use the + * nextSibling and nextEndSibling MUST have the same parent. If not, use the * DTDinsertNode. * This function does not try to know if the location of the new Node is DTD valid. * @param newNode The new Node to insert. - * @param tqparent The tqparent of the Node. + * @param parent The parent of the Node. * @param nextSibling The next sibling of the Node. * @param nextEndSibling The next sibling of the closing Node if created. If nextEndSibling == * nextSibling, the closing Node will be placed at the right of the newly created Node. @@ -320,13 +320,13 @@ public: * @param modifs The changes made are logged into modifs. * @return Returns a pointer to the node inserted. */ - static Node *insertNode(Node *newNode, Node *tqparent, Node *nextSibling, Node *nextEndSibling, + static Node *insertNode(Node *newNode, Node *parent, Node *nextSibling, Node *nextEndSibling, NodeModifsSet *modifs, bool merge = true); /** * It behaves essentially like the above function except that it can split the endNodeToSurround and * startNodeToSurround if necessary, according to the offsets. - * startNodeToSurround et endNodeToSurround MUST have the same tqparent. If not, use the last + * startNodeToSurround et endNodeToSurround MUST have the same parent. If not, use the last * DTDinsertNode. * This function does not try to know if the location of the new Node is valid. * @param startNodeToSurround The first Node which will be enclosed by the new Node. @@ -334,7 +334,7 @@ public: * @param startOffset The first Node will be splitted at offset startOffset, the right part will be enclosed. * @param endOffset The last Node will be splitted at offset endOffset, the left part will be enclosed. */ - static Node* insertNode(Node *newNode, Node *tqparent, Node *startNodeToSurround, + static Node* insertNode(Node *newNode, Node *parent, Node *startNodeToSurround, Node *endNodeToSurround, int startOffset, int endOffset, NodeModifsSet *modifs); /** @@ -353,7 +353,7 @@ public: * @param cursorNode The cursor is inside cursorNode. * @param cursorOffset The offset of the cursor inside cursorNode. * </TEMPORARY> - * @return Returns false if it wasn't possible to insert the tag because e.g. of an invalid tqparent. + * @return Returns false if it wasn't possible to insert the tag because e.g. of an invalid parent. */ static bool DTDinsertNode(Node *newNode, Node *startNode, int startOffset, Node *endNode, int endOffset, Document *doc, Node **cursorNode, long &cursorOffset, NodeModifsSet *modifs); @@ -373,7 +373,7 @@ public: * WARNING : baseNode is used as the rootNode. * It will also try to merge text/Empty Nodes. * @param node The root node of the Node subtree to insert. - * @param parentNode This Node will be the tqparent of node. + * @param parentNode This Node will be the parent of node. * @param nextSibling This Node will be the next Sibling of Node. If null, node will be appended at * the child list of parentNode. * @param modifs The changes made are logged into modifs. Put 0L if you don't want to log @@ -387,12 +387,12 @@ public: /** * It behaves essentially like the above function except that it can "surround" a set of Nodes with the * new Node. Thus, the closing Node is created if necessary. - * nextSibling and nextEndSibling MUST have the same tqparent. If not, use the + * nextSibling and nextEndSibling MUST have the same parent. If not, use the * DTDinsertNode. - * The Node Subtree MUST be a single-Node-per-tqparent subtree. + * The Node Subtree MUST be a single-Node-per-parent subtree. * This function does not try to know if the location of the new Node is DTD valid. * @param node The root node of the Node subtree to insert. - * @param tqparent The tqparent of the Node. + * @param parent The parent of the Node. * @param nextSibling The next sibling of the Node. * @param nextEndSibling The next sibling of the closing Node if created. If nextEndSibling == * nextSibling, the closing Node will be placed at the right of the newly created Node. @@ -425,17 +425,17 @@ public: * @param tagString The string of the tag. * @param nodeType The type of the Node cf Tag::TokenType. * @param doc The Node belongs to this Document. - * @param tqparent The tqparent of the Node. + * @param parent The parent of the Node. * @param nextSibling The next sibling of the Node. * @return Returns a pointer to the newly created Node. */ static Node *createAndInsertNode(const TQString &nodeName, const TQString &tagString, int nodeType, - Document *doc, Node* tqparent, Node* nextSibling, NodeModifsSet *modifs, bool merge = true); + Document *doc, Node* parent, Node* nextSibling, NodeModifsSet *modifs, bool merge = true); /** * It behaves essentially like the above function except that it reate its closing Node if necessary - * and then insert them with tqparent as Node's tqparent. - * nextSibling and nextEndSibling MUST have the same tqparent. If not, use the + * and then insert them with parent as Node's parent. + * nextSibling and nextEndSibling MUST have the same parent. If not, use the * DTDcreateAndInsertNode. * @param nextEndSibling The next sibling of the closing Node if created. If nextEndSibling == * nextSibling, the closing Node will be placed at the right of the newly created Node. @@ -443,11 +443,11 @@ public: * @param modifs The changes made are logged into modifs. */ static Node *createAndInsertNode(const TQString &nodeName, const TQString &tagString, int nodeType, - Document *doc, Node *tqparent, Node *nextSibling, Node *nextEndSibling, NodeModifsSet *modifs); + Document *doc, Node *parent, Node *nextSibling, Node *nextEndSibling, NodeModifsSet *modifs); /** * It behaves essentially like the above function except that if necessary, it will split the Nodes. - * startNodeToSurround et endNodeToSurround MUST have the same tqparent. If not, use the + * startNodeToSurround et endNodeToSurround MUST have the same parent. If not, use the * DTDcreateAndInsertNode. * This function does not try to know if the location of the new Node is valid. * @param startNodeToSurround The first Node which will be enclosed by the new Node. @@ -456,7 +456,7 @@ public: * @param endOffset The last Node will be splitted at offset endOffset, the left part will be enclosed. */ static Node *createAndInsertNode(const TQString &nodeName, const TQString &tagString, - int nodeType, Document *doc, Node *tqparent, Node *startNodeToSurround, + int nodeType, Document *doc, Node *parent, Node *startNodeToSurround, Node *endNodeToSurround, int startOffset, int endOffset, NodeModifsSet *modifs); /** @@ -470,7 +470,7 @@ public: * @param startOffset If firstNode is a text, specify at which offset the new Node must begin to surround. * @param endNode The last Node which must be surrounded by the new Node. * @param endOffset If endNode is a text, specify at which offset the new Node must stop to surround. - * @return Returns false if it wasn't possible to insert the tag because e.g. of an invalid tqparent. + * @return Returns false if it wasn't possible to insert the tag because e.g. of an invalid parent. */ static bool DTDcreateAndInsertNode(const TQString &nodeName, const TQString &tagString, int nodeType, Document *doc, Node *startNode, int startOffset, Node *endNode, int endOffset, @@ -523,7 +523,7 @@ public: * @param node The node to delete. * @param modifs The changes made are logged into modifs. * @param extractChilds If we extract or move up the tqchildren. WARNING: it don't check - * if the tqchildren of node are legal childs of the tqparent of node. + * if the tqchildren of node are legal childs of the parent of node. * @param removeClosingTag Extract the closingTag if node isn't single and is Tag::XmlTag. * TODO: @param removeEmbeddedTags Specifies if we delete the embedded Nodes e.g. * <a href="<? boo ?>" > : the PHP block is an embedded block. @@ -593,7 +593,7 @@ public: //The node to extract was not found. nothingExtracted = 0, //The extract operation stopped because of a DTD error : if the node was removed, the child - //weren't able to be childs of the node's tqparent, according to the DTD. Should not occur + //weren't able to be childs of the node's parent, according to the DTD. Should not occur //except really bad HTML. extractionStoppedDueToBadNodes, //everything has gone fine @@ -628,7 +628,7 @@ public: /** * Moves a Node somewhere else. * @param nodeToMove The node to move :-) - * @param newParent The new tqparent of nodeToMove. + * @param newParent The new parent of nodeToMove. * @param newNextSibling The new next Sibling of nodeToMove. If null, node will be appended at * the child list of parentNode. * @param modifs The changes made are logged into modifs. @@ -695,10 +695,10 @@ public: * @param startOffset * @param endNode The node where a selection ends, for example. * @param endOffset - * @param commonParent This is the common tqparent between start and end node. + * @param commonParent This is the common parent between start and end node. * If 0, it tries to find the commonParent, else it uses the passed node. - * @param commonParentStartChildLocation The first child of commonParent which is tqparent of startNode is stored here. - * @param commonParentEndChildLocation The first child of commonParent which is tqparent of endNode is stored here. + * @param commonParentStartChildLocation The first child of commonParent which is parent of startNode is stored here. + * @param commonParentEndChildLocation The first child of commonParent which is parent of endNode is stored here. * @param cursorNode The cursor node is stored here. * @param cursorOffset The cursor offset is stored here. * @param subTree The node corresponding to the start of a subtree that doesn't belong to the current document, or 0. @@ -809,8 +809,8 @@ public: /** * Get the node corresponding to a sublocation. * @param loc A location of a Node. - * @locOffset We want the (totalNumberOfParent - locOffset)th tqparent of Node. - * @return Returns a tqparent of the node pointed by loc. + * @locOffset We want the (totalNumberOfParent - locOffset)th parent of Node. + * @return Returns a parent of the node pointed by loc. */ static Node* getNodeFromSubLocation(TQValueList<int> loc, int locOffset); @@ -856,18 +856,18 @@ public: * Get the node's depth in the tree. * @param node The node we want the depth. * @return Returns the depth of node. It is basically the number of parents of node. - * It will return 0 if node has no tqparent Nodes, and -1 if node doesn't exists. + * It will return 0 if node has no parent Nodes, and -1 if node doesn't exists. */ static int nodeDepth(Node *node); /** - * Looks if node has a tqparent which is named name. - * @return Returns the first tqparent which is named name or 0L if not found. + * Looks if node has a parent which is named name. + * @return Returns the first parent which is named name or 0L if not found. */ static Node* hasParent(Node *node, const TQString &name); /** - * Tries to find the common tqparent to startNode and endNode, in the same conditions as above. + * Tries to find the common parent to startNode and endNode, in the same conditions as above. */ static Node* hasParent(Node* startNode, Node* endNode, const TQString &name); @@ -879,12 +879,12 @@ public: * WARNING : The postEnhancement is not done (cf htmlenhancer.h) * Prefer using KafkaDocument::insertDomNode() * @param node The node to insert. - * @param tqparent The new tqparent of node. If null, insert node at the top level. + * @param parent The new parent of node. If null, insert node at the top level. * @param nextSibling The new next sibling of node. If null, append node at the end of the child list. - * @param rootNode The root DOM::Node of the DOM::Node tree. Useful when no tqparent is provided. + * @param rootNode The root DOM::Node of the DOM::Node tree. Useful when no parent is provided. * @return Returns true if the operation was successfull. */ - static bool insertDomNode(DOM::Node node, DOM::Node tqparent = DOM::Node(), + static bool insertDomNode(DOM::Node node, DOM::Node parent = DOM::Node(), DOM::Node nextSibling = DOM::Node(), DOM::Node rootNode = DOM::Node()); @@ -978,21 +978,21 @@ public: const TQString &attrName, const TQString &attrValue, DOM::Document rootNode); /** - * Looks if domNode has a tqparent which is named name. - * @return Returns the first tqparent which is named name or an empty DOM::Node if not found. + * Looks if domNode has a parent which is named name. + * @return Returns the first parent which is named name or an empty DOM::Node if not found. */ static DOM::Node hasParent(DOM::Node domNode, const TQString &name); /** * Returns the position of the child domNode. * @param domNode This is the DOM::Node we want the position. - * @return Returns the position of domNode inside domNode's tqparent's tqchildren or -1 if not found. + * @return Returns the position of domNode inside domNode's parent's tqchildren or -1 if not found. */ static int childPosition(DOM::Node domNode); /** * Returns the position'th child of parentNode. - * @param parentNode The tqparent Node of the node to return. + * @param parentNode The parent Node of the node to return. * @param position We return the position'th child Node. * @param fallback If set to true, it will always return a valid Node (except if there is no child!!) */ @@ -1005,10 +1005,10 @@ public: static bool isInline(DOM::Node domNode); /** - * Specify if tqparent supports the siblings DOM::Nodes starting from startNode to endNode + * Specify if parent supports the siblings DOM::Nodes starting from startNode to endNode * according to the DTD dtd. */ - static bool parentSupports(DOM::Node tqparent, DOM::Node startNode, DOM::Node endNode, + static bool parentSupports(DOM::Node parent, DOM::Node startNode, DOM::Node endNode, const DTDStruct* dtd); @@ -1030,7 +1030,7 @@ public: /** * Prints in stdout the current Node tree. * @param node The startNode - * @param indent The number of little dots per tqparent relationship. + * @param indent The number of little dots per parent relationship. */ static void coutTree(Node *node, int indent); @@ -1085,7 +1085,7 @@ public: private: /** - * Split the last valid start tqparent (commonParentStartChild) into two. + * Split the last valid start parent (commonParentStartChild) into two. * This and the method above are related and are used in sequence. * The following tree: * <body> @@ -1120,14 +1120,14 @@ private: * </b> * </body> * @param startNode The node where a selection starts, for example. - * @param commonParent This is the common tqparent between start and end node. - * @param commonParentStartChildLocation The first child of commonParent which is tqparent of startNode + * @param commonParent This is the common parent between start and end node. + * @param commonParentStartChildLocation The first child of commonParent which is parent of startNode * @param modifs The changes made are logged into modifs. */ static void splitStartNodeSubtree(Node* startNode, Node* commonParent, TQValueList<int>& commonParentStartChildLocation, NodeModifsSet* modifs); /** - * Split the last valid start tqparent (commonParentStartChild) into two. + * Split the last valid start parent (commonParentStartChild) into two. * The following tree: * <body> * <b> --> commonParent @@ -1162,9 +1162,9 @@ private: * </b> * </body> * @param endNode The node where a selection ends, for example. - * @param commonParent This is the common tqparent between start and end node. - * @param commonParentStartChildLocation The first child of commonParent which is tqparent of startNode. - * @param commonParentEndChildLocation The first child of commonParent which is tqparent of endNode. + * @param commonParent This is the common parent between start and end node. + * @param commonParentStartChildLocation The first child of commonParent which is parent of startNode. + * @param commonParentEndChildLocation The first child of commonParent which is parent of endNode. * @param subTree True if we are dealing with a tree that doesn't belong to the current document. * @param modifs The changes made are logged into modifs. */ |