Make sender column clickable
[quassel.git] / src / qtui / chatitem.h
index 0710b6a..1184740 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-08 by the Quassel Project                          *
+ *   Copyright (C) 2005-2010 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
 #ifndef CHATITEM_H_
 #define CHATITEM_H_
 
-#include <QGraphicsItem>
+#include <QAction>
 #include <QObject>
 
 #include "chatlinemodel.h"
 #include "chatscene.h"
+#include "clickable.h"
 #include "uistyle.h"
 #include "qtui.h"
 
-class QTextLayout;
-struct ChatItemPrivate;
+#include <QTextLayout>
 
-class ChatItem : public QGraphicsItem {
+class ChatLine;
+
+/* All external positions are relative to the parent ChatLine */
+/* Yes, that's also true for the boundingRect() and related things */
+
+class ChatItem {
 protected:
-  ChatItem(const qreal &width, const qreal &height, const QPointF &pos, QGraphicsItem *parent);
-  virtual ~ChatItem();
+  // boundingRect is relative to the parent ChatLine
+  ChatItem(const QRectF &boundingRect, ChatLine *parent);
+  virtual ~ChatItem() {}
 
 public:
   inline const QAbstractItemModel *model() const;
+  inline ChatLine *chatLine() const;
+  inline ChatScene *chatScene() const;
   inline int row() const;
   virtual ChatLineModel::ColumnType column() const = 0;
-  inline ChatScene *chatScene() const { return qobject_cast<ChatScene *>(scene()); }
-
-  inline QRectF boundingRect() const { return _boundingRect; }
-  inline qreal width() const { return _boundingRect.width(); }
-  inline qreal height() const { return _boundingRect.height(); }
 
-  QTextLayout *createLayout(QTextOption::WrapMode, Qt::Alignment = Qt::AlignLeft) const;
-  virtual void doLayout();
-  void clearLayout();
+  // The boundingRect() is relative to the parent ChatLine
+  inline QRectF boundingRect() const;
+  inline qreal width() const;
+  inline qreal height() const;
+  inline QPointF pos() const;
+  inline qreal x() const;
+  inline qreal y() const;
+
+  inline QPointF mapToLine(const QPointF &) const;
+  inline QPointF mapFromLine(const QPointF &) const;
+  inline QPointF mapToScene(const QPointF &) const;
+  inline QPointF mapFromScene(const QPointF &) const;
+
+  void initLayoutHelper(QTextLayout *layout, QTextOption::WrapMode, Qt::Alignment = Qt::AlignLeft) const;
+  virtual inline void initLayout(QTextLayout *layout) const {
+    initLayoutHelper(layout, QTextOption::NoWrap);
+    doLayout(layout);
+  }
+  virtual void doLayout(QTextLayout *) const;
+  virtual UiStyle::FormatList formatList() const;
 
   virtual void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = 0);
-  enum { Type = ChatScene::ChatItemType };
-  virtual inline int type() const { return Type; }
+  virtual inline int type() const { return ChatScene::ChatItemType; }
 
   QVariant data(int role) const;
 
@@ -67,64 +86,56 @@ public:
 
   QList<QRectF> findWords(const QString &searchWord, Qt::CaseSensitivity caseSensitive);
 
+  virtual void addActionsToMenu(QMenu *menu, const QPointF &itemPos);
   virtual void handleClick(const QPointF &pos, ChatScene::ClickMode);
 
 protected:
+  enum SelectionMode {
+    NoSelection,
+    PartialSelection,
+    FullSelection
+  };
+
   virtual void mouseMoveEvent(QGraphicsSceneMouseEvent *event);
   virtual void mousePressEvent(QGraphicsSceneMouseEvent *event);
   virtual void mouseReleaseEvent(QGraphicsSceneMouseEvent *event);
+  virtual void hoverEnterEvent(QGraphicsSceneHoverEvent *) {};
+  virtual void hoverLeaveEvent(QGraphicsSceneHoverEvent *) {};
+  virtual void hoverMoveEvent(QGraphicsSceneHoverEvent *) {};
 
-  inline QTextLayout *layout() const;
+  void paintBackground(QPainter *);
+  QVector<QTextLayout::FormatRange> selectionFormats() const;
+  virtual QVector<QTextLayout::FormatRange> additionalFormats() const;
+  void overlayFormat(UiStyle::FormatList &fmtList, int start, int end, quint32 overlayFmt) const;
 
-  virtual QTextLayout::FormatRange selectionFormat() const;
-  virtual inline QVector<QTextLayout::FormatRange> additionalFormats() const { return QVector<QTextLayout::FormatRange>(); }
+  inline qint16 selectionStart() const { return _selectionStart; }
+  inline void setSelectionStart(qint16 start) { _selectionStart = start; }
+  inline qint16 selectionEnd() const { return _selectionEnd; }
+  inline void setSelectionEnd(qint16 end) { _selectionEnd = end; }
+  inline SelectionMode selectionMode() const { return _selectionMode; }
+  inline void setSelectionMode(SelectionMode mode) { _selectionMode = mode; }
+  void setSelection(SelectionMode mode, qint16 selectionStart, qint16 selectionEnd);
 
   qint16 posToCursor(const QPointF &pos) const;
 
-  inline bool hasPrivateData() const { return (bool)_data; }
-  ChatItemPrivate *privateData() const;
-  virtual inline ChatItemPrivate *newPrivateData();
-
-  // WARNING: setGeometry and setHeight should not be used without either:
-  //  a) calling prepareGeometryChange() immediately before setColumns()
-  //  b) calling Chatline::setPos() immediately afterwards
-  inline void setGeometry(qreal width, qreal height) {
-    _boundingRect.setWidth(width);
-    _boundingRect.setHeight(height);
-  }
-  inline void setHeight(const qreal &height) {
-    _boundingRect.setHeight(height);
-  }
-  inline void setWidth(const qreal &width) {
-    _boundingRect.setWidth(width);
-  }
+  inline void setGeometry(qreal width, qreal height) { _boundingRect.setSize(QSizeF(width, height)); }
+  inline void setHeight(const qreal &height) { _boundingRect.setHeight(height); }
+  inline void setWidth(const qreal &width) { _boundingRect.setWidth(width); }
+  inline void setPos(const QPointF &pos) { _boundingRect.moveTopLeft(pos); }
 
 private:
-  // internal selection stuff
-  void setSelection(int start, int length);
-
-  ChatItemPrivate *_data;
+  ChatLine *_parent;
   QRectF _boundingRect;
 
-  enum SelectionMode { NoSelection, PartialSelection, FullSelection };
   SelectionMode _selectionMode;
   qint16 _selectionStart, _selectionEnd;
 
-  friend class ChatLine;
-};
+  // internal selection stuff
+  void setSelection(int start, int length);
 
-struct ChatItemPrivate {
-  QTextLayout *layout;
-  ChatItemPrivate(QTextLayout *l) : layout(l) {}
-  ~ChatItemPrivate() {
-    delete layout;
-  }
+  friend class ChatLine;
 };
 
-// inlines of ChatItem
-QTextLayout *ChatItem::layout() const { return privateData()->layout; }
-ChatItemPrivate *ChatItem::newPrivateData() { return new ChatItemPrivate(createLayout(QTextOption::WrapAnywhere)); }
-
 // ************************************************************
 // TimestampChatItem
 // ************************************************************
@@ -132,9 +143,8 @@ ChatItemPrivate *ChatItem::newPrivateData() { return new ChatItemPrivate(createL
 //! A ChatItem for the timestamp column
 class TimestampChatItem : public ChatItem {
 public:
-  TimestampChatItem(const qreal &width, const qreal &height, QGraphicsItem *parent) : ChatItem(width, height, QPointF(0, 0), parent) {}
-  enum { Type = ChatScene::TimestampChatItemType };
-  virtual inline int type() const { return Type; }
+  TimestampChatItem(const QRectF &boundingRect, ChatLine *parent) : ChatItem(boundingRect, parent) {}
+  virtual inline int type() const { return ChatScene::TimestampChatItemType; }
   virtual inline ChatLineModel::ColumnType column() const { return ChatLineModel::TimestampColumn; }
 };
 
@@ -144,14 +154,17 @@ public:
 //! A ChatItem for the sender column
 class SenderChatItem : public ChatItem {
 public:
-  SenderChatItem(const qreal &width, const qreal &height, const QPointF &pos, QGraphicsItem *parent) : ChatItem(width, height, pos, parent) {}
+  SenderChatItem(const QRectF &boundingRect, ChatLine *parent) : ChatItem(boundingRect, parent) {}
   virtual inline ChatLineModel::ColumnType column() const { return ChatLineModel::SenderColumn; }
+  virtual void handleClick(const QPointF &pos, ChatScene::ClickMode clickMode);
 
 protected:
   virtual void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = 0);
-  enum { Type = ChatScene::SenderChatItemType };
-  virtual inline int type() const { return Type; }
-  virtual inline ChatItemPrivate *newPrivateData() { return new ChatItemPrivate(createLayout(QTextOption::ManualWrap, Qt::AlignRight)); }
+  virtual inline int type() const { return ChatScene::SenderChatItemType; }
+  virtual inline void initLayout(QTextLayout *layout) const {
+    initLayoutHelper(layout, QTextOption::ManualWrap, Qt::AlignRight);
+    doLayout(layout);
+  }
 };
 
 // ************************************************************
@@ -161,35 +174,44 @@ struct ContentsChatItemPrivate;
 
 //! A ChatItem for the contents column
 class ContentsChatItem : public ChatItem {
+  Q_DECLARE_TR_FUNCTIONS(ContentsChatItem)
+
 public:
-  ContentsChatItem(const qreal &width, const QPointF &pos, QGraphicsItem *parent);
+  ContentsChatItem(const QPointF &pos, const qreal &width, ChatLine *parent);
+  ~ContentsChatItem();
 
-  enum { Type = ChatScene::ContentsChatItemType };
-  virtual inline int type() const { return Type; }
+  virtual inline int type() const { return ChatScene::ContentsChatItemType; }
 
   inline ChatLineModel::ColumnType column() const { return ChatLineModel::ContentsColumn; }
-  inline QFontMetricsF *fontMetrics() const { return _fontMetrics; }
+  QFontMetricsF *fontMetrics() const;
 
 protected:
   virtual void mouseMoveEvent(QGraphicsSceneMouseEvent *event);
   virtual void hoverLeaveEvent(QGraphicsSceneHoverEvent *event);
   virtual void hoverMoveEvent(QGraphicsSceneHoverEvent *event);
-  virtual void contextMenuEvent(QGraphicsSceneContextMenuEvent *event);
-
   virtual void handleClick(const QPointF &pos, ChatScene::ClickMode clickMode);
 
+  virtual void addActionsToMenu(QMenu *menu, const QPointF &itemPos);
+  virtual void copyLinkToClipboard();
+
   virtual QVector<QTextLayout::FormatRange> additionalFormats() const;
 
-  virtual void doLayout();
-  virtual inline ChatItemPrivate *newPrivateData();
+  virtual inline void initLayout(QTextLayout *layout) const {
+    initLayoutHelper(layout, QTextOption::WrapAtWordBoundaryOrAnywhere);
+    doLayout(layout);
+  }
+  virtual void doLayout(QTextLayout *layout) const;
+  virtual UiStyle::FormatList formatList() const;
 
 private:
-  struct Clickable;
+  class ActionProxy;
   class WrapColumnFinder;
 
-  inline ContentsChatItemPrivate *privateData() const;
+  ContentsChatItemPrivate *_data;
+  ContentsChatItemPrivate *privateData() const;
+
+  Clickable clickableAt(const QPointF &pos) const;
 
-  QList<Clickable> findClickables() const;
   void endHoverMode();
   void showWebPreview(const Clickable &click);
   void clearWebPreview();
@@ -199,49 +221,30 @@ private:
   friend struct ContentsChatItemPrivate;
 
   QFontMetricsF *_fontMetrics;
-};
-
-struct ContentsChatItem::Clickable {
-  // Don't change these enums without also changing the regexps in analyze()!
-  enum Type {
-    Invalid = -1,
-    Url = 0,
-    Channel = 1,
-    Nick = 2
-  };
 
-  Type type;
-  quint16 start;
-  quint16 length;
-
-  inline Clickable() : type(Invalid) {};
-  inline Clickable(Type type_, quint16 start_, quint16 length_) : type(type_), start(start_), length(length_) {};
-  inline bool isValid() const { return type != Invalid; }
+  // we need a receiver for Action signals
+  static ActionProxy _actionProxy;
 };
 
-struct ContentsChatItemPrivate : ChatItemPrivate {
+struct ContentsChatItemPrivate {
   ContentsChatItem *contentsItem;
-  QList<ContentsChatItem::Clickable> clickables;
-  ContentsChatItem::Clickable currentClickable;
+  ClickableList clickables;
+  Clickable currentClickable;
+  Clickable activeClickable;
 
-  ContentsChatItemPrivate(QTextLayout *l, const QList<ContentsChatItem::Clickable> &c, ContentsChatItem *parent)
-  : ChatItemPrivate(l), contentsItem(parent), clickables(c) {}
+  ContentsChatItemPrivate(const ClickableList &c, ContentsChatItem *parent) : contentsItem(parent), clickables(c) {}
 };
 
-//inlines regarding ContentsChatItemPrivate
-ChatItemPrivate *ContentsChatItem::newPrivateData() { return new ContentsChatItemPrivate(createLayout(QTextOption::WrapAnywhere), findClickables(), this); }
-ContentsChatItemPrivate *ContentsChatItem::privateData() const { return (ContentsChatItemPrivate *)ChatItem::privateData(); }
-
 class ContentsChatItem::WrapColumnFinder {
 public:
-  WrapColumnFinder(ChatItem *parent);
+  WrapColumnFinder(const ChatItem *parent);
   ~WrapColumnFinder();
 
-  qint16 nextWrapColumn();
+  qint16 nextWrapColumn(qreal width);
 
 private:
-  ChatItem *item;
-  QTextLayout *layout;
+  const ChatItem *item;
+  QTextLayout layout;
   QTextLine line;
   ChatLineModel::WrapList wrapList;
   qint16 wordidx;
@@ -249,11 +252,50 @@ private:
   qreal choppedTrailing;
 };
 
+//! Acts as a proxy for Action signals targetted at a ContentsChatItem
+/** Since a ChatItem is not a QObject, hence cannot receive signals, we use a static ActionProxy
+ *  as a receiver instead. This avoids having to handle ChatItem actions (e.g. context menu entries)
+ *  outside the ChatItem.
+ */
+class ContentsChatItem::ActionProxy : public QObject {
+  Q_OBJECT
+
+public slots:
+  inline void copyLinkToClipboard() { item()->copyLinkToClipboard(); }
+
+private:
+  /// Returns the ContentsChatItem that should receive the action event.
+  /** For efficiency reasons, values are not checked for validity. You gotta make sure that you set the data() member
+   *  in the Action correctly.
+   *  @return The ChatItem from which the sending Action originated
+   */
+  inline ContentsChatItem *item() const {
+    return static_cast<ContentsChatItem *>(qobject_cast<QAction *>(sender())->data().value<void *>());
+  }
+};
+
 /*************************************************************************************************/
 
-// Avoid circular include deps
-#include "chatline.h"
-const QAbstractItemModel *ChatItem::model() const { return static_cast<ChatLine *>(parentItem())->model(); }
-int ChatItem::row() const { return static_cast<ChatLine *>(parentItem())->row(); }
+#include "chatline.h"  /* avoid circular includes */
+
+// Inlines
+
+ChatLine *ChatItem::chatLine() const { return _parent; }
+ChatScene *ChatItem::chatScene() const { return chatLine()->chatScene(); }
+const QAbstractItemModel *ChatItem::model() const { return chatLine()->model(); }
+int ChatItem::row() const { return chatLine()->row(); }
+
+QRectF ChatItem::boundingRect() const { return _boundingRect; }
+qreal ChatItem::width() const { return _boundingRect.width(); }
+qreal ChatItem::height() const { return _boundingRect.height(); }
+QPointF ChatItem::pos() const { return _boundingRect.topLeft(); }
+qreal ChatItem::x() const { return pos().x(); }
+qreal ChatItem::y() const { return pos().y(); }
+
+QPointF ChatItem::mapToLine(const QPointF &p) const { return p + pos(); }
+QPointF ChatItem::mapFromLine(const QPointF &p) const { return p - pos(); }
+// relative to the ChatLine
+QPointF ChatItem::mapToScene(const QPointF &p) const { return chatLine()->mapToScene(p /* + pos() */); }
+QPointF ChatItem::mapFromScene(const QPointF &p) const { return chatLine()->mapFromScene(p) /* - pos() */; }
 
 #endif