khtml/editing/htmlediting.h

   1 /*
   2  * Copyright (C) 2004 Apple Computer, Inc.  All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef __htmlediting_h__
  27 #define __htmlediting_h__
  28
  29 #include "edit_command.h"
  30
  31 #include "xml/dom_nodeimpl.h"
  32
  33 namespace DOM {
  34     class CSSStyleDeclarationImpl;
  35     class DocumentFragmentImpl;
  36     class DocumentImpl;
  37     class DOMString;
  38     class ElementImpl;
  39     class NodeImpl;
  40     class Position;
  41     class Selection;
  42     class TextImpl;
  43 }
  44
  45 namespace khtml {
  46
  47 class AppendNodeCommandImpl;
  48 class ApplyStyleCommandImpl;
  49 class CompositeEditCommandImpl;
  50 class DeleteCollapsibleWhitespaceCommandImpl;
  51 class DeleteSelectionCommandImpl;
  52 class DeleteTextCommandImpl;
  53 class EditCommand;
  54 class EditCommandImpl;
  55 class InputNewlineCommandImpl;
  56 class InputTextCommandImpl;
  57 class InsertNodeBeforeCommandImpl;
  58 class InsertTextCommandImpl;
  59 class JoinTextNodesCommandImpl;
  60 class MoveSelectionCommandImpl;
  61 class ReplaceSelectionCommandImpl;
  62 class RemoveCSSPropertyCommandImpl;
  63 class RemoveNodeAttributeCommandImpl;
  64 class RemoveNodeCommandImpl;
  65 class RemoveNodeAndPruneCommandImpl;
  66 class RemoveNodePreservingChildrenCommandImpl;
  67 class SetNodeAttributeCommandImpl;
  68 class SplitTextNodeCommandImpl;
  69 class TypingCommandImpl;
  70
  71 //------------------------------------------------------------------------------------------
  72 // CompositeEditCommand
  73
  74 class CompositeEditCommand : public EditCommand
  75 {
  76 public:
  77         CompositeEditCommand();
  78         CompositeEditCommand(CompositeEditCommandImpl *);
  79         CompositeEditCommand(const CompositeEditCommand &);
  80         ~CompositeEditCommand();
  81
  82 private:
  83     inline CompositeEditCommandImpl *impl() const;
  84 };
  85
  86 //==========================================================================================
  87 // Concrete commands
  88 //------------------------------------------------------------------------------------------
  89 // AppendNodeCommand
  90
  91 class AppendNodeCommand : public EditCommand
  92 {
  93 public:
  94     AppendNodeCommand(DOM::DocumentImpl *, DOM::NodeImpl *parentNode, DOM::NodeImpl *appendChild);
  95         ~AppendNodeCommand();
  96
  97     DOM::NodeImpl *parentNode() const;
  98     DOM::NodeImpl *appendChild() const;
  99
 100 private:
 101     inline AppendNodeCommandImpl *impl() const;
 102 };
 103
 104 //------------------------------------------------------------------------------------------
 105 // ApplyStyleCommand
 106
 107 class ApplyStyleCommand : public CompositeEditCommand
 108 {
 109 public:
 110         ApplyStyleCommand(DOM::DocumentImpl *, DOM::CSSStyleDeclarationImpl *);
 111         ~ApplyStyleCommand();
 112
 113     DOM::CSSStyleDeclarationImpl *style() const;
 114
 115 private:
 116     inline ApplyStyleCommandImpl *impl() const;
 117 };
 118
 119 //------------------------------------------------------------------------------------------
 120 // DeleteCollapsibleWhitespaceCommand
 121
 122 class DeleteCollapsibleWhitespaceCommand : public CompositeEditCommand
 123 {
 124 public:
 125         DeleteCollapsibleWhitespaceCommand(DOM::DocumentImpl *document);
 126         DeleteCollapsibleWhitespaceCommand(DOM::DocumentImpl *document, const DOM::Selection &selection);
 127
 128         ~DeleteCollapsibleWhitespaceCommand();
 129
 130 private:
 131     inline DeleteCollapsibleWhitespaceCommandImpl *impl() const;
 132 };
 133
 134 //------------------------------------------------------------------------------------------
 135 // DeleteSelectionCommand
 136
 137 class DeleteSelectionCommand : public CompositeEditCommand
 138 {
 139 public:
 140         DeleteSelectionCommand(DOM::DocumentImpl *document);
 141         DeleteSelectionCommand(DOM::DocumentImpl *document, const DOM::Selection &selection);
 142         ~DeleteSelectionCommand();
 143
 144 private:
 145     inline DeleteSelectionCommandImpl *impl() const;
 146 };
 147
 148 //------------------------------------------------------------------------------------------
 149 // DeleteTextCommand
 150
 151 class DeleteTextCommand : public EditCommand
 152 {
 153 public:
 154         DeleteTextCommand(DOM::DocumentImpl *document, DOM::TextImpl *, long offset, long count);
 155         DeleteTextCommand(const DeleteTextCommand &);
 156         ~DeleteTextCommand();
 157
 158     DOM::TextImpl *node() const;
 159     long offset() const;
 160     long count() const;
 161
 162 private:
 163     inline DeleteTextCommandImpl *impl() const;
 164 };
 165
 166 //------------------------------------------------------------------------------------------
 167 // InputNewlineCommand
 168
 169 class InputNewlineCommand : public CompositeEditCommand
 170 {
 171 public:
 172     InputNewlineCommand(DOM::DocumentImpl *document);
 173     ~InputNewlineCommand();
 174
 175 private:
 176     inline InputNewlineCommandImpl *impl() const;
 177 };
 178
 179 //------------------------------------------------------------------------------------------
 180 // InputTextCommand
 181
 182 class InputTextCommand : public CompositeEditCommand
 183 {
 184 public:
 185     InputTextCommand(DOM::DocumentImpl *document);
 186     ~InputTextCommand();
 187
 188     void deleteCharacter();
 189     void input(const DOM::DOMString &text);
 190
 191     unsigned long charactersAdded() const;
 192
 193 private:
 194     inline InputTextCommandImpl *impl() const;
 195 };
 196
 197 //------------------------------------------------------------------------------------------
 198 // InsertNodeBeforeCommand
 199
 200 class InsertNodeBeforeCommand : public EditCommand
 201 {
 202 public:
 203     InsertNodeBeforeCommand();
 204     InsertNodeBeforeCommand(DOM::DocumentImpl *, DOM::NodeImpl *insertChild, DOM::NodeImpl *refChild);
 205     InsertNodeBeforeCommand(const InsertNodeBeforeCommand &);
 206     ~InsertNodeBeforeCommand();
 207
 208     DOM::NodeImpl *insertChild() const;
 209     DOM::NodeImpl *refChild() const;
 210
 211 private:
 212     inline InsertNodeBeforeCommandImpl *impl() const;
 213 };
 214
 215 //------------------------------------------------------------------------------------------
 216 // InsertTextCommand
 217
 218 class InsertTextCommand : public EditCommand
 219 {
 220 public:
 221         InsertTextCommand(DOM::DocumentImpl *document, DOM::TextImpl *, long, const DOM::DOMString &);
 222         ~InsertTextCommand();
 223
 224     DOM::TextImpl *node() const;
 225     long offset() const;
 226     DOM::DOMString text() const;
 227
 228 private:
 229     inline InsertTextCommandImpl *impl() const;
 230 };
 231
 232 //------------------------------------------------------------------------------------------
 233 // JoinTextNodesCommand
 234
 235 class JoinTextNodesCommand : public EditCommand
 236 {
 237 public:
 238         JoinTextNodesCommand(DOM::DocumentImpl *, DOM::TextImpl *, DOM::TextImpl *);
 239         ~JoinTextNodesCommand();
 240
 241     DOM::TextImpl *firstNode() const;
 242     DOM::TextImpl *secondNode() const;
 243
 244 private:
 245     inline JoinTextNodesCommandImpl *impl() const;
 246 };
 247
 248 //------------------------------------------------------------------------------------------
 249 // ReplaceSelectionCommand
 250
 251 class ReplaceSelectionCommand : public CompositeEditCommand
 252 {
 253 public:
 254     ReplaceSelectionCommand(DOM::DocumentImpl *document, DOM::DocumentFragmentImpl *fragment, bool selectReplacement=true);
 255     ~ReplaceSelectionCommand();
 256
 257 private:
 258     inline ReplaceSelectionCommandImpl *impl() const;
 259 };
 260
 261 //------------------------------------------------------------------------------------------
 262 // MoveSelectionCommand
 263
 264 class MoveSelectionCommand : public CompositeEditCommand
 265 {
 266 public:
 267     MoveSelectionCommand(DOM::DocumentImpl *document, DOM::DocumentFragmentImpl *fragment, DOM::Position &position);
 268     ~MoveSelectionCommand();
 269
 270 private:
 271         inline MoveSelectionCommandImpl *impl() const;
 272 };
 273
 274 //------------------------------------------------------------------------------------------
 275 // RemoveCSSPropertyCommand
 276
 277 class RemoveCSSPropertyCommand : public EditCommand
 278 {
 279 public:
 280         RemoveCSSPropertyCommand(DOM::DocumentImpl *, DOM::CSSStyleDeclarationImpl *, int property);
 281         ~RemoveCSSPropertyCommand();
 282
 283     DOM::CSSStyleDeclarationImpl *styleDeclaration() const;
 284     int property() const;
 285
 286 private:
 287     inline RemoveCSSPropertyCommandImpl *impl() const;
 288 };
 289
 290 //------------------------------------------------------------------------------------------
 291 // RemoveNodeAttributeCommand
 292
 293 class RemoveNodeAttributeCommand : public EditCommand
 294 {
 295 public:
 296         RemoveNodeAttributeCommand(DOM::DocumentImpl *, DOM::ElementImpl *, DOM::NodeImpl::Id attribute);
 297         ~RemoveNodeAttributeCommand();
 298
 299     DOM::ElementImpl *element() const;
 300     DOM::NodeImpl::Id attribute() const;
 301
 302 private:
 303     inline RemoveNodeAttributeCommandImpl *impl() const;
 304 };
 305
 306 //------------------------------------------------------------------------------------------
 307 // RemoveNodeCommand
 308
 309 class RemoveNodeCommand : public EditCommand
 310 {
 311 public:
 312         RemoveNodeCommand(DOM::DocumentImpl *, DOM::NodeImpl *node);
 313         ~RemoveNodeCommand();
 314
 315     DOM::NodeImpl *node() const;
 316
 317 private:
 318     inline RemoveNodeCommandImpl *impl() const;
 319 };
 320
 321 //------------------------------------------------------------------------------------------
 322 // RemoveNodeAndPruneCommand
 323
 324 class RemoveNodeAndPruneCommand : public CompositeEditCommand
 325 {
 326 public:
 327         RemoveNodeAndPruneCommand(DOM::DocumentImpl *, DOM::NodeImpl *pruneNode, DOM::NodeImpl *stopNode=0);
 328         ~RemoveNodeAndPruneCommand();
 329
 330     DOM::NodeImpl *pruneNode() const;
 331     DOM::NodeImpl *stopNode() const;
 332
 333 private:
 334     inline RemoveNodeAndPruneCommandImpl *impl() const;
 335 };
 336
 337 //------------------------------------------------------------------------------------------
 338 // RemoveNodePreservingChildrenCommand
 339
 340 class RemoveNodePreservingChildrenCommand : public CompositeEditCommand
 341 {
 342 public:
 343     RemoveNodePreservingChildrenCommand(DOM::DocumentImpl *document, DOM::NodeImpl *node);
 344     ~RemoveNodePreservingChildrenCommand();
 345
 346     DOM::NodeImpl *node() const;
 347
 348 private:
 349     inline RemoveNodePreservingChildrenCommandImpl *impl() const;
 350 };
 351
 352 //------------------------------------------------------------------------------------------
 353 // SetNodeAttributeCommand
 354
 355 class SetNodeAttributeCommand : public EditCommand
 356 {
 357 public:
 358         SetNodeAttributeCommand(DOM::DocumentImpl *, DOM::ElementImpl *, DOM::NodeImpl::Id attribute, const DOM::DOMString &value);
 359         ~SetNodeAttributeCommand();
 360
 361     DOM::ElementImpl *element() const;
 362     DOM::NodeImpl::Id attribute() const;
 363     DOM::DOMString value() const;
 364
 365 private:
 366     inline SetNodeAttributeCommandImpl *impl() const;
 367 };
 368
 369 //------------------------------------------------------------------------------------------
 370 // SplitTextNodeCommand
 371
 372 class SplitTextNodeCommand : public EditCommand
 373 {
 374 public:
 375         SplitTextNodeCommand(DOM::DocumentImpl *, DOM::TextImpl *, long);
 376         ~SplitTextNodeCommand();
 377
 378     DOM::TextImpl *node() const;
 379     long offset() const;
 380
 381 private:
 382     inline SplitTextNodeCommandImpl *impl() const;
 383 };
 384
 385 //------------------------------------------------------------------------------------------
 386 // TypingCommand
 387
 388 class TypingCommand : public CompositeEditCommand
 389 {
 390 public:
 391     static void deleteKeyPressed(DOM::DocumentImpl *document);
 392     static void insertText(DOM::DocumentImpl *document, const DOM::DOMString &text);
 393     static void insertNewline(DOM::DocumentImpl *document);
 394     static bool isOpenForMoreTypingCommand(const EditCommand &);
 395     static void closeTyping(EditCommand);
 396
 397     bool openForMoreTyping() const;
 398     void closeTyping();
 399
 400 private:
 401         TypingCommand(DOM::DocumentImpl *document);
 402         TypingCommand(TypingCommand *);
 403         TypingCommand(const TypingCommand &);
 404         ~TypingCommand();
 405
 406     void deleteKeyPressed();
 407     void insertText(const DOM::DOMString &text);
 408     void insertNewline();
 409
 410     inline TypingCommandImpl *impl() const;
 411 };
 412
 413 //------------------------------------------------------------------------------------------
 414
 415 } // end namespace khtml
 416
 417 #endif