git.sesse.net Git - kdenlive/blob - src/titlewidget.h

   1 /***************************************************************************
   2                           titlewidget.h  -  description
   3                              -------------------
   4     begin                : Feb 28 2008
   5     copyright            : (C) 2008 by Marco Gittler
   6     email                : g.marco@freenet.de
   7  ***************************************************************************/
   8
   9 /***************************************************************************
  10  *                                                                         *
  11  *   This program is free software; you can redistribute it and/or modify  *
  12  *   it under the terms of the GNU General Public License as published by  *
  13  *   the Free Software Foundation; either version 2 of the License, or     *
  14  *   (at your option) any later version.                                   *
  15  *                                                                         *
  16  ***************************************************************************/
  17
  18 #ifndef TITLEWIDGET_H
  19 #define TITLEWIDGET_H
  20
  21 #include "ui_titlewidget_ui.h"
  22 #include "titledocument.h"
  23 #include "renderer.h"
  24 #include "graphicsscenerectmove.h"
  25 #include "unicodedialog.h"
  26 #include "timecode.h"
  27
  28 #include <QMap>
  29 #include <QSignalMapper>
  30
  31 class TitleTemplate
  32 {
  33 public:
  34     QString file;
  35     QString name;
  36     QIcon icon;
  37 };
  38
  39 class Transform
  40 {
  41 public:
  42     Transform() {
  43         scalex = 1.0;
  44         scaley = 1.0;
  45         rotatex = 0.0;
  46         rotatey = 0.0;
  47         rotatez = 0.0;
  48     }
  49     double scalex, scaley;
  50     double rotatex, rotatey, rotatez;
  51 };
  52
  53
  54 class TitleWidget : public QDialog , public Ui::TitleWidget_UI
  55 {
  56     Q_OBJECT
  57
  58 public:
  59
  60     /** @brief Draws the dialog and loads a title document (if any).
  61      * @param url title document to load
  62      * @param tc timecode of the project
  63      * @param projectPath default path to save to or load from title documents
  64      * @param render project renderer
  65      * @param parent (optional) parent widget */
  66     TitleWidget(KUrl url, Timecode tc, QString projectTitlePath, Render *render, QWidget *parent = 0);
  67     virtual ~TitleWidget();
  68     QDomDocument xml();
  69     void setXml(QDomDocument doc);
  70
  71     /** @brief Finds the first available file name for a title document.
  72      * @deprecated With the titler module there's no need to save titles as images.
  73      * @param projectUrl project directory
  74      * @param isClone (optional) if true, the file name will be cloneXXX.png
  75      * @return list with title name (Title XXX or Clone XXX) and file name
  76      *
  77      * The path "/titles/" is appended to projectUrl, and the format of the file name is (title|clone)XXX.png. */
  78     static QStringList getFreeTitleInfo(const KUrl &projectUrl, bool isClone = false);
  79
  80     /** @brief Checks for the images referenced by a title clip.
  81      * @param xml XML data representing the title
  82      * @return list of the image files */
  83     static QStringList extractImageList(QString xml);
  84
  85     /** @brief Checks for the fonts referenced by a title clip.
  86      * @param xml XML data representing the title
  87      * @return list of the fonts */
  88     static QStringList extractFontList(QString xml);
  89
  90     /** @brief Builds a file name for a title document.
  91      * @deprecated With the titler module there's no need to save titles as images.
  92      * @param projectUrl project directory
  93      * @param titleName name of title, in the form titleXXX
  94      * @return file name composed with the given arguments
  95      *
  96      * The path "/titles/" is appended to projectUrl, and .png is appended to
  97      * get the file name. There is no check for the existence of the file. */
  98     static QString getTitleResourceFromName(const KUrl &projectUrl, const QString &titleName);
  99
 100     /** @brief Returns clip out position. */
 101     int outPoint() const;
 102
 103     /** @brief Retrieves a list of all available title templates. */
 104     static void refreshTitleTemplates();
 105
 106 protected:
 107     virtual void resizeEvent(QResizeEvent * event);
 108
 109 private:
 110
 111     /** @brief Rectangle describing the animation start viewport. */
 112     QGraphicsRectItem *m_startViewport;
 113
 114     /** @brief Rectangle describing the animation end viewport. */
 115     QGraphicsRectItem *m_endViewport;
 116
 117     /** @brief Scene for the titler. */
 118     GraphicsSceneRectMove *m_scene;
 119
 120     /** @brief Initialises the animation properties (viewport size, etc.). */
 121     void initAnimation();
 122     QMap<QGraphicsItem*, Transform > m_transformations;
 123     TitleDocument m_titledocument;
 124     QGraphicsRectItem *m_frameBorder;
 125     QGraphicsPixmapItem *m_frameImage;
 126     int m_frameWidth;
 127     int m_frameHeight;
 128     Render *m_render;   // TODO Is NOT destroyed in the destructor. Deliberately?
 129     int m_count;
 130     QAction *m_buttonRect;
 131     QAction *m_buttonText;
 132     QAction *m_buttonImage;
 133     QAction *m_buttonCursor;
 134     QAction *m_buttonSave;
 135     QAction *m_buttonLoad;
 136
 137     QAction *m_unicodeAction;
 138     QAction *m_zUp;
 139     QAction *m_zDown;
 140     QAction *m_zTop;
 141     QAction *m_zBottom;
 142     QAction *m_selectAll;
 143     QAction *m_selectText;
 144     QAction *m_selectRects;
 145     QAction *m_selectImages;
 146     QAction *m_unselectAll;
 147
 148     /** @brief Dialog for entering Unicode characters in text fields. */
 149     UnicodeDialog *m_unicodeDialog;
 150
 151     /** @brief Project path for storing title documents. */
 152     QString m_projectTitlePath;
 153     Timecode m_tc;
 154     QString lastDocumentHash;
 155
 156     // See http://doc.trolltech.com/4.5/signalsandslots.html#advanced-signals-and-slots-usage.
 157     QSignalMapper *m_signalMapper;
 158
 159     enum ValueType { ValueWidth = 0, ValueHeight = 1 };
 160
 161     /** @brief Sets the font weight value in the combo box. (#909) */
 162     void setFontBoxWeight(int weight);
 163
 164     /** @brief Stores the choices of font, background and rectangle values. */
 165     void writeChoices();
 166
 167     /** @brief Reads the last stored choices into the dialog. */
 168     void readChoices();
 169
 170     /** @brief Updates the displayed X/Y coordinates. */
 171     void updateCoordinates(QGraphicsItem *i);
 172
 173     /** @brief Updates the displayed width/height values. */
 174     void updateDimension(QGraphicsItem *i);
 175
 176     /** @brief Updates the displayed rotation/zoom values. */
 177     void updateRotZoom(QGraphicsItem *i);
 178
 179     /** @brief Updates the item position. */
 180     void updatePosition(QGraphicsItem *i);
 181
 182     void textChanged(QGraphicsTextItem *i);
 183     void updateAxisButtons(QGraphicsItem *i);
 184
 185     void updateTextOriginX();
 186     void updateTextOriginY();
 187
 188     /** @brief Enables the toolbars suiting to toolType. */
 189     void enableToolbars(TITLETOOL toolType);
 190
 191     /** @brief Shows the toolbars suiting to toolType. */
 192     void showToolbars(TITLETOOL toolType);
 193
 194     /** @brief Checks a tool button. */
 195     void checkButton(TITLETOOL toolType);
 196
 197     void adjustFrameSize();
 198
 199     /** @brief Adds a "start" and "end" info text to the animation viewports. */
 200     void addAnimInfoText();
 201
 202     /** @brief Updates the font for the "start" and "end" info text. */
 203     void updateInfoText();
 204
 205     /** @brief Removes the "start" and "end" info text from animation viewports. */
 206     void deleteAnimInfoText();
 207
 208     qreal maxZIndex();
 209
 210     /** @brief Gets the minimum/maximum Z index of items.
 211      * @param maxBound true: use maximum Z index; false: use minimum
 212      * @param intersectingOnly if true, consider only the items intersecting
 213      *     with the currently selected item
 214      */
 215     qreal zIndexBounds(bool maxBound, bool intersectingOnly);
 216
 217     void itemRotate(qreal val, int axis);
 218
 219     void selectItems(int itemType);
 220
 221     /** @brief Appends the shortcut of a QAction to a tooltip text */
 222     QString getTooltipWithShortcut(const QString text, QAction *button);
 223
 224 public slots:
 225     void slotNewText(QGraphicsTextItem *tt);
 226     void slotNewRect(QGraphicsRectItem *rect);
 227     void slotChangeBackground();
 228
 229     /** @brief Sets up the tools (toolbars etc.) according to the selected item. */
 230     void selectionChanged();
 231     void rectChanged();
 232     void setupViewports();
 233     void zIndexChanged(int);
 234     void itemScaled(int);
 235     void itemRotateX(qreal);
 236     void itemRotateY(qreal);
 237     void itemRotateZ(qreal);
 238     /** Save a title to a title file */
 239     void saveTitle(KUrl url = KUrl());
 240     /** Load a title from a title file */
 241     void loadTitle(KUrl url = KUrl());
 242
 243 private slots:
 244
 245     /** @brief Updates position/size of the selected item when a value changes. */
 246     void slotAdjustSelectedItem();
 247
 248     /** @brief Switches the origin of the X axis between left and right border.
 249      *
 250      * It's called when the origin of the X coordinate has been changed. The X
 251      * origin will either be at the left or at the right side of the frame.
 252      *
 253      * When the origin of the X axis is at the left side, the user can enter the
 254      * distance between an element's left border and the left side of the frame.
 255      *
 256      * When on the right, the distance from the right border of the frame to the
 257      * right border of the element can be entered. This would result in negative
 258      * values as long as the element's right border is at the left of the
 259      * frame's right border. As that is usually the case, I additionally invert
 260      * the X axis.
 261      *
 262      * Default value is left.
 263      *
 264      * |----l----->|#######|----r--->|
 265      * |           |---w-->|         |
 266      * |           |#######|         |
 267      * |                             |
 268      * |----------m_frameWidth------>|
 269      * |                             |
 270      *
 271      * Left selected: Value = l
 272      * Right selected: Value = r
 273      *
 274      * To calculate between the two coorindate systems:
 275      * l = m_frameWidth - w - r
 276      * r = m_frameWidth - w - l
 277      */
 278     void slotOriginXClicked();
 279
 280     /** @brief Same as slotOriginXClicked(), but for the Y axis; default is top.
 281      * @ref slotOriginXClicked */
 282     void slotOriginYClicked();
 283
 284     /** @brief Updates coordinates of text fields if necessary.
 285      *
 286      * It's called when something changes in the QGraphicsScene. */
 287     void slotChanged();
 288
 289     /** @param valueType of type ValueType */
 290     void slotValueChanged(int valueType);
 291
 292     void slotZoom(bool up);
 293     void slotUpdateZoom(int pos);
 294     void slotAdjustZoom();
 295     void slotZoomOneToOne();
 296
 297     void slotSelectAll();
 298     void slotSelectText();
 299     void slotSelectRects();
 300     void slotSelectImages();
 301     void slotSelectNone();
 302
 303
 304     /** Called whenever text properties change (font e.g.) */
 305     void slotUpdateText();
 306     void slotInsertUnicode();
 307     void slotInsertUnicodeString(QString);
 308
 309     void displayBackgroundFrame();
 310
 311     void setCurrentItem(QGraphicsItem *item);
 312
 313     void slotTextTool();
 314     void slotRectTool();
 315     void slotSelectTool();
 316     void slotImageTool();
 317
 318     void slotAnimStart(bool);
 319     void slotAnimEnd(bool);
 320     void slotKeepAspect(bool keep);
 321
 322     void itemHCenter();
 323     void itemVCenter();
 324     void itemTop();
 325     void itemBottom();
 326     void itemLeft();
 327     void itemRight();
 328     void slotResize50();
 329     void slotResize100();
 330     void slotResize200();
 331
 332     /** @brief Called when accepted, stores user selections for next time use.
 333      * @ref writeChoices */
 334     void slotAccepted();
 335
 336     void slotFontText(const QString& s);
 337
 338     /** @brief Adds an effect to an element.
 339      * @param ix index of the effect in the effects menu
 340      *
 341      * The current implementation allows for one QGraphicsEffect to be added
 342      * along with the typewriter effect. This is not clear to the user: the
 343      * stack would help, and would permit us to make more QGraphicsEffects
 344      * coexist (with different layers of QGraphicsItems). */
 345     void slotAddEffect(int ix);
 346     void slotEditBlur(int ix);
 347     void slotEditShadow();
 348     void slotEditTypewriter(int ix);
 349
 350     /** @brief Changes the Z index of objects. */
 351     void slotZIndexUp();
 352     void slotZIndexDown();
 353     void slotZIndexTop();
 354     void slotZIndexBottom();
 355     /** Called when the user wants to apply a different template to the title */
 356     void templateIndexChanged(int);
 357 };
 358
 359 #endif