WebCore/TextEvent.h

   1 /*
   2  * Copyright (C) 2007, 2008 Apple 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
  27 #ifndef TextEvent_h
  28 #define TextEvent_h
  29
  30 #include "UIEvent.h"
  31
  32 namespace WebCore {
  33
  34     class TextEvent : public UIEvent {
  35     public:
  36         static PassRefPtr<TextEvent> create()
  37         {
  38             return adoptRef(new TextEvent);
  39         }
  40         static PassRefPtr<TextEvent> create(PassRefPtr<AbstractView> view, const String& data)
  41         {
  42             return adoptRef(new TextEvent(view, data));
  43         }
  44         virtual ~TextEvent();
  45
  46         void initTextEvent(const AtomicString& type, bool canBubble, bool cancelable, PassRefPtr<AbstractView>, const String& data);
  47
  48         String data() const { return m_data; }
  49
  50         virtual bool isTextEvent() const;
  51
  52         // If true, any newline characters in the text are line breaks only, not paragraph separators.
  53         bool isLineBreak() const { return m_isLineBreak; }
  54         void setIsLineBreak(bool isLineBreak) { m_isLineBreak = isLineBreak; }
  55
  56         // If true, any tab characters in the text are backtabs.
  57         bool isBackTab() const { return m_isBackTab; }
  58         void setIsBackTab(bool isBackTab) { m_isBackTab = isBackTab; }
  59
  60     private:
  61         TextEvent();
  62         TextEvent(PassRefPtr<AbstractView>, const String& data);
  63
  64         String m_data;
  65         bool m_isLineBreak;
  66         bool m_isBackTab;
  67     };
  68
  69 } // namespace WebCore
  70
  71 #endif // TextEvent_h