Make sender column clickable
[quassel.git] / src / qtui / chatitem.h
index b58dc03..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  *
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
 
-#ifndef _CHATITEM_H_
-#define _CHATITEM_H_
+#ifndef CHATITEM_H_
+#define CHATITEM_H_
 
-#include <QGraphicsItem>
-#include <QTextLayout>
-#include <QTextOption>
+#include <QAction>
+#include <QObject>
 
-#include "chatline.h"
 #include "chatlinemodel.h"
+#include "chatscene.h"
+#include "clickable.h"
 #include "uistyle.h"
+#include "qtui.h"
+
+#include <QTextLayout>
+
+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:
+  // 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;
+
+  // 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);
+  virtual inline int type() const { return ChatScene::ChatItemType; }
+
+  QVariant data(int role) const;
+
+  // selection stuff, to be called by the scene
+  QString selection() const;
+  void clearSelection();
+  void setFullSelection();
+  void continueSelecting(const QPointF &pos);
+  bool hasSelection() const;
+  bool isPosOverSelection(const QPointF &pos) const;
+
+  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 *) {};
+
+  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;
+
+  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 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:
+  ChatLine *_parent;
+  QRectF _boundingRect;
+
+  SelectionMode _selectionMode;
+  qint16 _selectionStart, _selectionEnd;
+
+  // internal selection stuff
+  void setSelection(int start, int length);
+
+  friend class ChatLine;
+};
+
+// ************************************************************
+// TimestampChatItem
+// ************************************************************
+
+//! A ChatItem for the timestamp column
+class TimestampChatItem : public ChatItem {
+public:
+  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; }
+};
+
+// ************************************************************
+// SenderChatItem
+// ************************************************************
+//! A ChatItem for the sender column
+class SenderChatItem : public ChatItem {
+public:
+  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);
+  virtual inline int type() const { return ChatScene::SenderChatItemType; }
+  virtual inline void initLayout(QTextLayout *layout) const {
+    initLayoutHelper(layout, QTextOption::ManualWrap, Qt::AlignRight);
+    doLayout(layout);
+  }
+};
+
+// ************************************************************
+// ContentsChatItem
+// ************************************************************
+struct ContentsChatItemPrivate;
+
+//! A ChatItem for the contents column
+class ContentsChatItem : public ChatItem {
+  Q_DECLARE_TR_FUNCTIONS(ContentsChatItem)
+
+public:
+  ContentsChatItem(const QPointF &pos, const qreal &width, ChatLine *parent);
+  ~ContentsChatItem();
+
+  virtual inline int type() const { return ChatScene::ContentsChatItemType; }
+
+  inline ChatLineModel::ColumnType column() const { return ChatLineModel::ContentsColumn; }
+  QFontMetricsF *fontMetrics() const;
+
+protected:
+  virtual void mouseMoveEvent(QGraphicsSceneMouseEvent *event);
+  virtual void hoverLeaveEvent(QGraphicsSceneHoverEvent *event);
+  virtual void hoverMoveEvent(QGraphicsSceneHoverEvent *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 inline void initLayout(QTextLayout *layout) const {
+    initLayoutHelper(layout, QTextOption::WrapAtWordBoundaryOrAnywhere);
+    doLayout(layout);
+  }
+  virtual void doLayout(QTextLayout *layout) const;
+  virtual UiStyle::FormatList formatList() const;
+
+private:
+  class ActionProxy;
+  class WrapColumnFinder;
 
-class ChatItem : public QGraphicsItem {
+  ContentsChatItemPrivate *_data;
+  ContentsChatItemPrivate *privateData() const;
 
-  public:
-    ChatItem(const QPersistentModelIndex &index, QGraphicsItem *parent);
-    virtual ~ChatItem();
+  Clickable clickableAt(const QPointF &pos) const;
 
-    inline QPersistentModelIndex index() const { return _index; }
-    inline const MessageModel *model() const { return _index.isValid() ? qobject_cast<const MessageModel *>(_index.model()) : 0; }
-    inline int row() const { return _index.isValid() ? _index.row() : 0; }
+  void endHoverMode();
+  void showWebPreview(const Clickable &click);
+  void clearWebPreview();
 
-    virtual QRectF boundingRect() const;
-    virtual void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = 0);
+  qreal setGeometryByWidth(qreal w);
+  friend class ChatLine;
+  friend struct ContentsChatItemPrivate;
 
-    virtual QVariant data(int role) const;
-    //QString text() const;
-    //void setText(const UiStyle::StyledText &text);
+  QFontMetricsF *_fontMetrics;
 
-    //QTextOption textOption() const;
-    //void setTextOption(const QTextOption &option);
+  // we need a receiver for Action signals
+  static ActionProxy _actionProxy;
+};
+
+struct ContentsChatItemPrivate {
+  ContentsChatItem *contentsItem;
+  ClickableList clickables;
+  Clickable currentClickable;
+  Clickable activeClickable;
+
+  ContentsChatItemPrivate(const ClickableList &c, ContentsChatItem *parent) : contentsItem(parent), clickables(c) {}
+};
+
+class ContentsChatItem::WrapColumnFinder {
+public:
+  WrapColumnFinder(const ChatItem *parent);
+  ~WrapColumnFinder();
+
+  qint16 nextWrapColumn(qreal width);
+
+private:
+  const ChatItem *item;
+  QTextLayout layout;
+  QTextLine line;
+  ChatLineModel::WrapList wrapList;
+  qint16 wordidx;
+  qint16 lineCount;
+  qreal choppedTrailing;
+};
 
-    //void setWidth(int width);
-    //virtual void layout();
+//! 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
 
-  protected:
-    //void mouseMoveEvent ( QGraphicsSceneMouseEvent * event );
+public slots:
+  inline void copyLinkToClipboard() { item()->copyLinkToClipboard(); }
 
-  private:
-    //int _width;
-    //QTextLayout _layout;
-    //QTextOption _textOption;
-    QPersistentModelIndex _index;
+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 *>());
+  }
 };
 
+/*************************************************************************************************/
+
+#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