okular/part/guiutils.h
David Hurka 19d5dd8ec7 New part/ directory for okularpart sources from /, ui/, conf/
Source files are no longer separated by UI and non-UI and similar,
but only by their build target.

* ui/ -> part/
* Move all source files from conf/ to part/
* Keep config skeleton definitions in conf/, needed for the mobile target too
* Move editdrawingtooldialogtest.h from conf/autotests/ to autotests/
* ui/data/icons/ -> icons/
* Move /part.cpp, /part.rc and similar files to part/
* Adapt include paths in source files
* Adapt CMakeLists.txt files (in / and in subdirectories)
* Adapt /Messages.sh
2020-11-18 19:32:56 +00:00

102 lines
3.4 KiB
C++

/***************************************************************************
* Copyright (C) 2006-2007 by Pino Toscano <pino@kde.org> *
* *
* 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. *
***************************************************************************/
#ifndef OKULAR_GUIUTILS_H
#define OKULAR_GUIUTILS_H
#include <QColor>
#include <QIcon>
#include <QString>
class QImage;
class QPixmap;
class QSize;
class QWidget;
class QFile;
class KIconLoader;
namespace Okular
{
class Annotation;
class EmbeddedFile;
class Movie;
class ScreenAnnotation;
}
namespace GuiUtils
{
/**
* Returns the translated string with the type of the given @p annotation.
*/
QString captionForAnnotation(const Okular::Annotation *annotation);
QString authorForAnnotation(const Okular::Annotation *annotation);
QString contentsHtml(const Okular::Annotation *annotation);
QString prettyToolTip(const Okular::Annotation *annotation);
/**
* Returns a pixmap for a stamp symbol
*
* @p name Name of a Okular stamp symbol, icon or path to an image
* @p size Size of the pixmap (ignore aspect ratio). Takes precedence over @p iconSize
* @p iconSize Maximum size of the pixmap (keep aspect ratio)
*/
QPixmap loadStamp(const QString &nameOrPath, int size, bool keepAspectRatio = true);
void addIconLoader(KIconLoader *loader);
void removeIconLoader(KIconLoader *loader);
KIconLoader *iconLoader();
void saveEmbeddedFile(Okular::EmbeddedFile *ef, QWidget *parent);
void writeEmbeddedFile(Okular::EmbeddedFile *ef, QWidget *parent, QFile &targetFile);
/**
* Returns the movie object that is referenced by a rendition action of the passed screen @p annotation
* or @c 0 if the screen annotation has no rendition action set or the rendition action does not contain
* a media rendition.
*/
Okular::Movie *renditionMovieFromScreenAnnotation(const Okular::ScreenAnnotation *annotation);
// colorize a gray image to the given color
void colorizeImage(QImage &image, const QColor &color, unsigned int alpha = 255);
enum ColorIconFlags {
NoFlags = 0x0,
VisualizeTransparent = 0x1 ///< Visualizes Qt::transparent with a cross.
};
/**
* Paints color rectangles on the lower 25% of an icon.
*
* If no icon is given, the whole icon square is filled, and a 1px border is added.
*
* Examples:
* * Different icons for different kinds of color selection, like fill and outline.
* * Selection of a color scheme preset, where each scheme has a different icon and ~1..3 specific colors.
*
* @param colors Which color rectangles to paint, from left to right (even on RTL). Colors may be transparent. Invalid colors are skipped.
* @param background Which icon to use as background.
* @param flags Special wishes.
*
* @returns A newly created QIcon.
*/
QIcon createColorIcon(const QList<QColor> &colors, const QIcon &background = QIcon(), ColorIconFlags flags = NoFlags);
/**
* Creates an opacity icon, using QPalette foreground color
* painted on top of a checkerboard pattern using @p opacity.
*
* @param opacity 0 = invisible, 1 = opaque.
*/
QIcon createOpacityIcon(qreal opacity);
}
#endif