tdesktop/Telegram/SourceFiles/history/media/history_media.h

245 lines
6.5 KiB
C
Raw Normal View History

/*
This file is part of Telegram Desktop,
the official desktop application for the Telegram messaging service.
For license and copyright information please follow this link:
https://github.com/telegramdesktop/tdesktop/blob/master/LEGAL
*/
#pragma once
#include "history/view/history_view_object.h"
struct HistoryMessageEdited;
struct TextSelection;
namespace base {
template <typename Enum>
class enum_mask;
} // namespace base
namespace Storage {
enum class SharedMediaType : signed char;
using SharedMediaTypesMask = base::enum_mask<SharedMediaType>;
} // namespace Storage
namespace HistoryView {
enum class PointState : char;
enum class CursorState : char;
enum class InfoDisplayType : char;
struct TextState;
struct StateRequest;
} // namespace HistoryView
enum class MediaInBubbleState {
None,
Top,
Middle,
Bottom,
};
class HistoryMedia : public HistoryView::Object {
public:
using Element = HistoryView::Element;
using PointState = HistoryView::PointState;
using TextState = HistoryView::TextState;
using StateRequest = HistoryView::StateRequest;
HistoryMedia(not_null<Element*> parent) : _parent(parent) {
}
[[nodiscard]] not_null<History*> history() const;
2019-01-03 12:36:01 +00:00
[[nodiscard]] virtual TextForMimeData selectedText(
TextSelection selection) const {
return TextForMimeData();
}
[[nodiscard]] virtual bool isDisplayed() const;
2017-12-13 18:10:48 +00:00
virtual void updateNeedBubbleState() {
}
[[nodiscard]] virtual bool hasTextForCopy() const {
return false;
}
[[nodiscard]] virtual bool hideMessageText() const {
2018-01-18 13:59:22 +00:00
return true;
}
[[nodiscard]] virtual bool allowsFastShare() const {
return false;
}
virtual void refreshParentId(not_null<HistoryItem*> realParent) {
}
virtual void draw(
Painter &p,
const QRect &r,
TextSelection selection,
crl::time ms) const = 0;
[[nodiscard]] virtual PointState pointState(QPoint point) const;
[[nodiscard]] virtual TextState textState(
QPoint point,
StateRequest request) const = 0;
2017-06-21 21:38:31 +00:00
virtual void updatePressed(QPoint point) {
}
[[nodiscard]] virtual Storage::SharedMediaTypesMask sharedMediaTypes() const;
// if we are in selecting items mode perhaps we want to
// toggle selection instead of activating the pressed link
[[nodiscard]] virtual bool toggleSelectionByHandlerClick(
2017-10-13 19:07:04 +00:00
const ClickHandlerPtr &p) const = 0;
// if we press and drag on this media should we drag the item
2017-10-13 19:07:04 +00:00
[[nodiscard]] virtual bool dragItem() const {
return false;
}
2017-10-13 19:07:04 +00:00
[[nodiscard]] virtual TextSelection adjustSelection(
TextSelection selection,
TextSelectType type) const {
return selection;
}
2017-10-13 19:07:04 +00:00
[[nodiscard]] virtual uint16 fullSelectionLength() const {
return 0;
}
2017-10-13 19:07:04 +00:00
[[nodiscard]] TextSelection skipSelection(
TextSelection selection) const;
2017-10-13 19:07:04 +00:00
[[nodiscard]] TextSelection unskipSelection(
TextSelection selection) const;
// if we press and drag this link should we drag the item
[[nodiscard]] virtual bool dragItemByHandler(
const ClickHandlerPtr &p) const = 0;
virtual void clickHandlerActiveChanged(const ClickHandlerPtr &p, bool active) {
}
virtual void clickHandlerPressedChanged(const ClickHandlerPtr &p, bool pressed) {
}
[[nodiscard]] virtual bool uploading() const {
return false;
}
[[nodiscard]] virtual PhotoData *getPhoto() const {
return nullptr;
}
[[nodiscard]] virtual DocumentData *getDocument() const {
return nullptr;
}
void playAnimation() {
playAnimation(false);
}
void autoplayAnimation() {
playAnimation(true);
}
virtual void stopAnimation() {
}
[[nodiscard]] virtual QSize sizeForGrouping() const {
2017-12-13 18:10:48 +00:00
Unexpected("Grouping method call.");
}
virtual void drawGrouped(
Painter &p,
const QRect &clip,
TextSelection selection,
crl::time ms,
2017-12-13 18:10:48 +00:00
const QRect &geometry,
RectParts corners,
not_null<uint64*> cacheKey,
not_null<QPixmap*> cache) const {
Unexpected("Grouping method call.");
}
[[nodiscard]] virtual TextState getStateGrouped(
const QRect &geometry,
QPoint point,
StateRequest request) const;
2017-12-13 18:10:48 +00:00
[[nodiscard]] virtual bool animating() const {
return false;
}
[[nodiscard]] virtual TextWithEntities getCaption() const {
return TextWithEntities();
}
[[nodiscard]] virtual bool needsBubble() const = 0;
[[nodiscard]] virtual bool customInfoLayout() const = 0;
[[nodiscard]] virtual QMargins bubbleMargins() const {
return QMargins();
}
[[nodiscard]] virtual bool hideForwardedFrom() const {
return false;
}
[[nodiscard]] virtual bool overrideEditedDate() const {
return false;
}
[[nodiscard]] virtual HistoryMessageEdited *displayedEditBadge() const {
Unexpected("displayedEditBadge() on non-grouped media.");
}
// An attach media in a web page can provide an
// additional text to be displayed below the attach.
// For example duration / progress for video messages.
[[nodiscard]] virtual QString additionalInfoString() const {
return QString();
}
void setInBubbleState(MediaInBubbleState state) {
_inBubbleState = state;
}
[[nodiscard]] MediaInBubbleState inBubbleState() const {
return _inBubbleState;
}
[[nodiscard]] bool isBubbleTop() const {
return (_inBubbleState == MediaInBubbleState::Top)
|| (_inBubbleState == MediaInBubbleState::None);
}
[[nodiscard]] bool isBubbleBottom() const {
return (_inBubbleState == MediaInBubbleState::Bottom)
|| (_inBubbleState == MediaInBubbleState::None);
}
[[nodiscard]] virtual bool skipBubbleTail() const {
return false;
}
[[nodiscard]] virtual bool hidesForwardedInfo() const {
return false;
}
// Sometimes webpages can force the bubble to fit their size instead of
// allowing message text to be as wide as possible (like wallpapers).
[[nodiscard]] virtual bool enforceBubbleWidth() const {
return false;
}
// Sometimes click on media in message is overloaded by the message:
// (for example it can open a link or a game instead of opening media)
// But the overloading click handler should be used only when media
// is already loaded (not a photo or GIF waiting for load with auto
// load being disabled - in such case media should handle the click).
[[nodiscard]] virtual bool isReadyForOpen() const {
return true;
}
// Should be called only by Data::Session.
virtual void updateSharedContactUserId(UserId userId) {
}
virtual void parentTextUpdated() {
}
virtual ~HistoryMedia() = default;
protected:
using CursorState = HistoryView::CursorState;
using InfoDisplayType = HistoryView::InfoDisplayType;
QSize countCurrentSize(int newWidth) override;
Text createCaption(not_null<HistoryItem*> item) const;
virtual void playAnimation(bool autoplay) {
}
not_null<Element*> _parent;
MediaInBubbleState _inBubbleState = MediaInBubbleState::None;
};