office/okular
office/okular
1
0
Fork 0
mirror of https://invent.kde.org/graphics/okular synced 2024-08-24 18:35:37 +00:00
Code Issues Packages Projects Releases Wiki Activity
okular/ui/annotwindow.cpp
Dileep Sankhla 6dd7cf662d Add typewriter annotation tool 
Summary:
Typewriter is originally specified by the PDF reference as special FreeText annotation, where Intent=FreeTextTypewriter. It features opaque letters on transparent background, so that users can fill non interactive forms. Herewith typewriter is implemented natively for PDF, and there's also an Okular specific implementation for other document types. The added tool reuses the inline note UI.

This work was done during GSoC 2018. See https://community.kde.org/GSoC/2018/StatusReports/DileepSankhla for details.

FEATURE: 353401

Test Plan:
- okularpartrc is generated (if not yet existing) with typewriter as 10th tool
- typewriter tool is also available in Annotation Tools -> Add, Typ "Typewriter"
- selecting the tool and left click into document opens inline note input dialog
- finishing creates an annotation similar to inline note, but with transparent background
- saving into PDF results in /Subtype FreeText /IT /FreeTextTypeWriter
- saving typewriter into archive stores color with alpha channel = 0x00
- opening annotated archive works, if archive was created with old Okular, and opened in patched Okular
- opening annotated archive works, if archive was created with patched Okular, and opened in old Okular

Reviewers: sander

Reviewed By: sander

Subscribers: ngraham, sander, okular-devel

Tags: #okular

Differential Revision: https://phabricator.kde.org/D15204
2018-09-25 22:47:01 +02:00

443 lines
15 KiB
C++
Raw Blame History

/***************************************************************************
* Copyright (C) 2006 by Chu Xiaodong <xiaodongchu@gmail.com> *
* Copyright (C) 2006 by Pino Toscano <pino@kde.org> *
* Copyright (C) 2017 Klarälvdalens Datakonsult AB, a KDAB Group *
* company, info@kdab.com. Work sponsored by the *
* LiMux project of the city of Munich *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
***************************************************************************/
#include "annotwindow.h"
// qt/kde includes
#include <qapplication.h>
#include <qevent.h>
#include <qfont.h>
#include <qfontinfo.h>
#include <qfontmetrics.h>
#include <qframe.h>
#include <qlabel.h>
#include <qlayout.h>
#include <qpushbutton.h>
#include <qsizegrip.h>
#include <qstyle.h>
#include <qtoolbutton.h>
#include <KLocalizedString>
#include <ktextedit.h>
#include <QDebug>
#include <qaction.h>
#include <kstandardaction.h>
#include <qmenu.h>
// local includes
#include "core/annotations.h"
#include "core/document.h"
#include "latexrenderer.h"
#include <core/utils.h>
#include <KMessageBox>
class CloseButton
: public QPushButton
{
Q_OBJECT
public:
CloseButton( QWidget * parent = Q_NULLPTR )
: QPushButton( parent )
{
setSizePolicy( QSizePolicy::Fixed, QSizePolicy::Fixed );
QSize size = QSize( 14, 14 ).expandedTo( QApplication::globalStrut() );
setFixedSize( size );
setIcon( style()->standardIcon( QStyle::SP_DockWidgetCloseButton ) );
setIconSize( size );
setToolTip( i18n( "Close this note" ) );
setCursor( Qt::ArrowCursor );
}
};
class MovableTitle
: public QWidget
{
Q_OBJECT
public:
MovableTitle( QWidget * parent )
: QWidget( parent )
{
QVBoxLayout * mainlay = new QVBoxLayout( this );
mainlay->setMargin( 0 );
mainlay->setSpacing( 0 );
// close button row
QHBoxLayout * buttonlay = new QHBoxLayout();
mainlay->addLayout( buttonlay );
titleLabel = new QLabel( this );
QFont f = titleLabel->font();
f.setBold( true );
titleLabel->setFont( f );
titleLabel->setCursor( Qt::SizeAllCursor );
buttonlay->addWidget( titleLabel );
dateLabel = new QLabel( this );
dateLabel->setAlignment( Qt::AlignTop | Qt::AlignRight );
f = dateLabel->font();
f.setPointSize( QFontInfo( f ).pointSize() - 2 );
dateLabel->setFont( f );
dateLabel->setCursor( Qt::SizeAllCursor );
buttonlay->addWidget( dateLabel );
CloseButton * close = new CloseButton( this );
connect( close, &QAbstractButton::clicked, parent, &QWidget::close );
buttonlay->addWidget( close );
// option button row
QHBoxLayout * optionlay = new QHBoxLayout();
mainlay->addLayout( optionlay );
authorLabel = new QLabel( this );
authorLabel->setCursor( Qt::SizeAllCursor );
authorLabel->setSizePolicy( QSizePolicy::Expanding, QSizePolicy::Minimum );
optionlay->addWidget( authorLabel );
optionButton = new QToolButton( this );
QString opttext = i18n( "Options" );
optionButton->setText( opttext );
optionButton->setAutoRaise( true );
QSize s = QFontMetrics( optionButton->font() ).boundingRect( opttext ).size() + QSize( 8, 8 );
optionButton->setSizePolicy( QSizePolicy::Fixed, QSizePolicy::Fixed );
optionButton->setFixedSize( s );
optionlay->addWidget( optionButton );
// ### disabled for now
optionButton->hide();
latexButton = new QToolButton( this );
QHBoxLayout * latexlay = new QHBoxLayout();
QString latextext = i18n ( "This annotation may contain LaTeX code.\nClick here to render." );
latexButton->setText( latextext );
latexButton->setAutoRaise( true );
s = QFontMetrics( latexButton->font() ).boundingRect(0, 0, this->width(), this->height(), 0, latextext ).size() + QSize( 8, 8 );
latexButton->setSizePolicy( QSizePolicy::Fixed, QSizePolicy::Fixed );
latexButton->setFixedSize( s );
latexButton->setCheckable( true );
latexButton->setVisible( false );
latexlay->addSpacing( 1 );
latexlay->addWidget( latexButton );
latexlay->addSpacing( 1 );
mainlay->addLayout( latexlay );
connect(latexButton, SIGNAL(clicked(bool)), parent, SLOT(renderLatex(bool)));
connect(parent, SIGNAL(containsLatex(bool)), latexButton, SLOT(setVisible(bool)));
titleLabel->installEventFilter( this );
dateLabel->installEventFilter( this );
authorLabel->installEventFilter( this );
}
bool eventFilter( QObject * obj, QEvent * e ) override
{
if ( obj != titleLabel && obj != authorLabel && obj != dateLabel )
return false;
QMouseEvent * me = nullptr;
switch ( e->type() )
{
case QEvent::MouseButtonPress:
me = (QMouseEvent*)e;
mousePressPos = me->pos();
parentWidget()->raise();
break;
case QEvent::MouseButtonRelease:
mousePressPos = QPoint();
break;
case QEvent::MouseMove:
me = (QMouseEvent*)e;
parentWidget()->move( me->pos() - mousePressPos + parentWidget()->pos() );
break;
default:
return false;
}
return true;
}
void setTitle( const QString& title )
{
titleLabel->setText( QStringLiteral( " " ) + title );
}
void setDate( const QDateTime& dt )
{
dateLabel->setText( QLocale().toString( dt, QLocale::ShortFormat ) + QLatin1Char(' ') );
}
void setAuthor( const QString& author )
{
authorLabel->setText( QStringLiteral( " " ) + author );
}
void connectOptionButton( QObject * recv, const char* method )
{
connect( optionButton, SIGNAL(clicked()), recv, method );
}
void uncheckLatexButton()
{
latexButton->setChecked( false );
}
private:
QLabel * titleLabel;
QLabel * dateLabel;
QLabel * authorLabel;
QPoint mousePressPos;
QToolButton * optionButton;
QToolButton * latexButton;
};
// Qt::SubWindow is needed to make QSizeGrip work
AnnotWindow::AnnotWindow( QWidget * parent, Okular::Annotation * annot, Okular::Document *document, int page )
: QFrame( parent, Qt::SubWindow ), m_annot( annot ), m_document( document ), m_page( page )
{
setAutoFillBackground( true );
setFrameStyle( Panel | Raised );
setAttribute( Qt::WA_DeleteOnClose );
setObjectName("AnnotWindow");
const bool canEditAnnotation = m_document->canModifyPageAnnotation( annot );
textEdit = new KTextEdit( this );
textEdit->setAcceptRichText( false );
textEdit->setPlainText( m_annot->contents() );
textEdit->installEventFilter( this );
textEdit->setUndoRedoEnabled( false );
m_prevCursorPos = textEdit->textCursor().position();
m_prevAnchorPos = textEdit->textCursor().anchor();
connect(textEdit, &KTextEdit::textChanged, this, &AnnotWindow::slotsaveWindowText);
connect(textEdit, &KTextEdit::cursorPositionChanged, this, &AnnotWindow::slotsaveWindowText);
connect(textEdit, &KTextEdit::aboutToShowContextMenu, this, &AnnotWindow::slotUpdateUndoAndRedoInContextMenu);
connect(m_document, &Okular::Document::annotationContentsChangedByUndoRedo, this, &AnnotWindow::slotHandleContentsChangedByUndoRedo);
if (!canEditAnnotation)
textEdit->setReadOnly(true);
QVBoxLayout * mainlay = new QVBoxLayout( this );
mainlay->setMargin( 2 );
mainlay->setSpacing( 0 );
m_title = new MovableTitle( this );
mainlay->addWidget( m_title );
mainlay->addWidget( textEdit );
QHBoxLayout * lowerlay = new QHBoxLayout();
mainlay->addLayout( lowerlay );
lowerlay->addItem( new QSpacerItem( 5, 5, QSizePolicy::Expanding, QSizePolicy::Fixed ) );
QSizeGrip * sb = new QSizeGrip( this );
lowerlay->addWidget( sb );
m_latexRenderer = new GuiUtils::LatexRenderer();
emit containsLatex( GuiUtils::LatexRenderer::mightContainLatex( m_annot->contents() ) );
m_title->setTitle( m_annot->window().summary() );
m_title->connectOptionButton( this, SLOT(slotOptionBtn()) );
setGeometry(10,10,300,300 );
reloadInfo();
}
AnnotWindow::~AnnotWindow()
{
delete m_latexRenderer;
}
Okular::Annotation * AnnotWindow::annotation() const
{
return m_annot;
}
void AnnotWindow::updateAnnotation( Okular::Annotation * a )
{
m_annot = a;
}
void AnnotWindow::reloadInfo()
{
QColor newcolor;
if ( m_annot->subType() == Okular::Annotation::AText )
{
Okular::TextAnnotation * textAnn = static_cast< Okular::TextAnnotation * >( m_annot );
if ( textAnn->textType() == Okular::TextAnnotation::InPlace && textAnn->inplaceIntent() == Okular::TextAnnotation::TypeWriter )
newcolor = QColor("#fdfd96");
}
if ( !newcolor.isValid() )
newcolor = m_annot->style().color().isValid() ? QColor(m_annot->style().color().red(), m_annot->style().color().green(), m_annot->style().color().blue(), 255) : Qt::yellow;
if ( newcolor != m_color )
{
m_color = newcolor;
setPalette( QPalette( m_color ) );
QPalette pl = textEdit->palette();
pl.setColor( QPalette::Base, m_color );
textEdit->setPalette( pl );
}
m_title->setAuthor( m_annot->author() );
m_title->setDate( m_annot->modificationDate() );
}
int AnnotWindow::pageNumber() const
{
return m_page;
}
void AnnotWindow::showEvent( QShowEvent * event )
{
QFrame::showEvent( event );
// focus the content area by default
textEdit->setFocus();
}
bool AnnotWindow::eventFilter(QObject *, QEvent *e)
{
if ( e->type () == QEvent::ShortcutOverride )
{
QKeyEvent * keyEvent = static_cast< QKeyEvent * >( e );
if ( keyEvent->key() == Qt::Key_Escape )
{
close();
return true;
}
}
else if (e->type() == QEvent::KeyPress)
{
QKeyEvent *keyEvent = static_cast<QKeyEvent*>(e);
if (keyEvent == QKeySequence::Undo)
{
m_document->undo();
return true;
}
else if (keyEvent == QKeySequence::Redo)
{
m_document->redo();
return true;
}
}
else if (e->type() == QEvent::FocusIn)
{
raise();
}
return false;
}
void AnnotWindow::slotUpdateUndoAndRedoInContextMenu(QMenu* menu)
{
if (!menu) return;
QList<QAction *> actionList = menu->actions();
enum { UndoAct, RedoAct, CutAct, CopyAct, PasteAct, ClearAct, SelectAllAct, NCountActs };
QAction *kundo = KStandardAction::create( KStandardAction::Undo, m_document, SLOT(undo()), menu);
QAction *kredo = KStandardAction::create( KStandardAction::Redo, m_document, SLOT(redo()), menu);
connect(m_document, &Okular::Document::canUndoChanged, kundo, &QAction::setEnabled);
connect(m_document, &Okular::Document::canRedoChanged, kredo, &QAction::setEnabled);
kundo->setEnabled(m_document->canUndo());
kredo->setEnabled(m_document->canRedo());
QAction *oldUndo, *oldRedo;
oldUndo = actionList[UndoAct];
oldRedo = actionList[RedoAct];
menu->insertAction(oldUndo, kundo);
menu->insertAction(oldRedo, kredo);
menu->removeAction(oldUndo);
menu->removeAction(oldRedo);
}
void AnnotWindow::slotOptionBtn()
{
//TODO: call context menu in pageview
//emit sig...
}
void AnnotWindow::slotsaveWindowText()
{
const QString contents = textEdit->toPlainText();
const int cursorPos = textEdit->textCursor().position();
if (contents != m_annot->contents())
{
m_document->editPageAnnotationContents( m_page, m_annot, contents, cursorPos, m_prevCursorPos, m_prevAnchorPos);
emit containsLatex( GuiUtils::LatexRenderer::mightContainLatex( textEdit->toPlainText() ) );
}
m_prevCursorPos = cursorPos;
m_prevAnchorPos = textEdit->textCursor().anchor();
}
void AnnotWindow::renderLatex( bool render )
{
if (render)
{
textEdit->setReadOnly( true );
disconnect(textEdit, &KTextEdit::textChanged, this, &AnnotWindow::slotsaveWindowText);
disconnect(textEdit, &KTextEdit::cursorPositionChanged, this, &AnnotWindow::slotsaveWindowText);
textEdit->setAcceptRichText( true );
QString contents = m_annot->contents();
contents = Qt::convertFromPlainText( contents );
QColor fontColor = textEdit->textColor();
int fontSize = textEdit->fontPointSize();
QString latexOutput;
GuiUtils::LatexRenderer::Error errorCode = m_latexRenderer->renderLatexInHtml( contents, fontColor, fontSize, Okular::Utils::realDpi(nullptr).width(), latexOutput );
switch ( errorCode )
{
case GuiUtils::LatexRenderer::LatexNotFound:
KMessageBox::sorry( this, i18n( "Cannot find latex executable." ), i18n( "LaTeX rendering failed" ) );
m_title->uncheckLatexButton();
renderLatex( false );
break;
case GuiUtils::LatexRenderer::DvipngNotFound:
KMessageBox::sorry( this, i18n( "Cannot find dvipng executable." ), i18n( "LaTeX rendering failed" ) );
m_title->uncheckLatexButton();
renderLatex( false );
break;
case GuiUtils::LatexRenderer::LatexFailed:
KMessageBox::detailedSorry( this, i18n( "A problem occurred during the execution of the 'latex' command." ), latexOutput, i18n( "LaTeX rendering failed" ) );
m_title->uncheckLatexButton();
renderLatex( false );
break;
case GuiUtils::LatexRenderer::DvipngFailed:
KMessageBox::sorry( this, i18n( "A problem occurred during the execution of the 'dvipng' command." ), i18n( "LaTeX rendering failed" ) );
m_title->uncheckLatexButton();
renderLatex( false );
break;
case GuiUtils::LatexRenderer::NoError:
default:
textEdit->setHtml( contents );
break;
}
}
else
{
textEdit->setAcceptRichText( false );
textEdit->setPlainText( m_annot->contents() );
connect(textEdit, &KTextEdit::textChanged, this, &AnnotWindow::slotsaveWindowText);
connect(textEdit, &KTextEdit::cursorPositionChanged, this, &AnnotWindow::slotsaveWindowText);
textEdit->setReadOnly( false );
}
}
void AnnotWindow::slotHandleContentsChangedByUndoRedo(Okular::Annotation* annot, QString contents, int cursorPos, int anchorPos)
{
if ( annot != m_annot )
{
return;
}
textEdit->setPlainText(contents);
QTextCursor c = textEdit->textCursor();
c.setPosition(anchorPos);
c.setPosition(cursorPos,QTextCursor::KeepAnchor);
m_prevCursorPos = cursorPos;
m_prevAnchorPos = anchorPos;
textEdit->setTextCursor(c);
textEdit->setFocus();
emit containsLatex( GuiUtils::LatexRenderer::mightContainLatex( m_annot->contents() ) );
}
#include "annotwindow.moc"
Reference in a new issue View git blame Copy permalink