1 /***************************************************************************
2 titlewidget.h - description
5 copyright : (C) 2008 by Marco Gittler
6 email : g.marco@freenet.de
7 ***************************************************************************/
9 /***************************************************************************
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. *
16 ***************************************************************************/
21 #include "ui_titlewidget_ui.h"
22 #include "titledocument.h"
24 #include "graphicsscenerectmove.h"
25 #include "unicodedialog.h"
29 #include <QSignalMapper>
49 double scalex, scaley;
50 double rotatex, rotatey, rotatez;
54 class TitleWidget : public QDialog , public Ui::TitleWidget_UI
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();
69 void setXml(QDomDocument doc);
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
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);
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);
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);
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
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);
100 /** @brief Returns clip out position. */
101 int outPoint() const;
103 /** @brief Loads title templates. */
104 static void refreshTitleTemplates();
107 virtual void resizeEvent(QResizeEvent * event);
111 /** @brief Rectangle describing the animation start viewport. */
112 QGraphicsRectItem *m_startViewport;
114 /** @brief Rectangle describing the animation end viewport. */
115 QGraphicsRectItem *m_endViewport;
117 /** @brief Scene for the titler. */
118 GraphicsSceneRectMove *m_scene;
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;
130 QAction *m_buttonRect;
131 QAction *m_buttonText;
132 QAction *m_buttonImage;
133 QAction *m_buttonCursor;
134 QAction *m_buttonSave;
135 QAction *m_buttonLoad;
137 QAction *m_unicodeAction;
143 /** @brief Dialog for entering Unicode characters in text fields. */
144 UnicodeDialog *m_unicodeDialog;
146 /** @brief Project path for storing title documents. */
147 QString m_projectTitlePath;
149 QString lastDocumentHash;
151 // See http://doc.trolltech.com/4.5/signalsandslots.html#advanced-signals-and-slots-usage.
152 QSignalMapper *m_signalMapper;
154 enum ValueType { ValueWidth = 0, ValueHeight = 1 };
156 /** @brief Sets the font weight value in the combo box. (#909) */
157 void setFontBoxWeight(int weight);
159 /** @brief Stores the choices of font, background and rectangle values. */
162 /** @brief Reads the last stored choices into the dialog. */
165 /** @brief Updates the displayed X/Y coordinates. */
166 void updateCoordinates(QGraphicsItem *i);
168 /** @brief Updates the displayed width/height values. */
169 void updateDimension(QGraphicsItem *i);
171 /** @brief Updates the displayed rotation/zoom values. */
172 void updateRotZoom(QGraphicsItem *i);
174 /** @brief Updates the item position. */
175 void updatePosition(QGraphicsItem *i);
177 void textChanged(QGraphicsTextItem *i);
178 void updateAxisButtons(QGraphicsItem *i);
180 void updateTextOriginX();
181 void updateTextOriginY();
183 /** @brief Enables the toolbars suiting to toolType. */
184 void enableToolbars(TITLETOOL toolType);
186 /** @brief Shows the toolbars suiting to toolType. */
187 void showToolbars(TITLETOOL toolType);
189 /** @brief Checks a tool button. */
190 void checkButton(TITLETOOL toolType);
192 void adjustFrameSize();
194 /** @brief Adds a "start" and "end" info text to the animation viewports. */
195 void addAnimInfoText();
197 /** @brief Updates the font for the "start" and "end" info text. */
198 void updateInfoText();
200 /** @brief Removes the "start" and "end" info text from animation viewports. */
201 void deleteAnimInfoText();
205 /** @brief Gets the minimum/maximum Z index of items.
206 * @param maxBound true: use maximum Z index; false: use minimum
207 * @param intersectingOnly if true, consider only the items intersecting
208 * with the currently selected item
210 qreal zIndexBounds(bool maxBound, bool intersectingOnly);
212 void itemRotate(qreal val, int axis);
215 void slotNewText(QGraphicsTextItem *tt);
216 void slotNewRect(QGraphicsRectItem *rect);
217 void slotChangeBackground();
219 /** @brief Sets up the tools according to the selected item. */
220 void selectionChanged();
222 void setupViewports();
223 void zIndexChanged(int);
224 void itemScaled(int);
225 void itemRotateX(qreal);
226 void itemRotateY(qreal);
227 void itemRotateZ(qreal);
228 void saveTitle(KUrl url = KUrl());
229 void loadTitle(KUrl url = KUrl());
233 /** @brief Updates position/size of the selected item when a value changes. */
234 void slotAdjustSelectedItem();
236 /** @brief Switches the origin of the X axis between left and right border.
238 * It's called when the origin of the X coordinate has been changed. The X
239 * origin will either be at the left or at the right side of the frame.
241 * When the origin of the X axis is at the left side, the user can enter the
242 * distance between an element's left border and the left side of the frame.
244 * When on the right, the distance from the right border of the frame to the
245 * right border of the element can be entered. This would result in negative
246 * values as long as the element's right border is at the left of the
247 * frame's right border. As that is usually the case, I additionally invert
250 * Default value is left.
252 * |----l----->|#######|----r--->|
256 * |----------m_frameWidth------>|
259 * Left selected: Value = l
260 * Right selected: Value = r
262 * To calculate between the two coorindate systems:
263 * l = m_frameWidth - w - r
264 * r = m_frameWidth - w - l
266 void slotOriginXClicked();
268 /** @brief Same as slotOriginXClicked(), but for the Y axis; default is top.
269 * @ref slotOriginXClicked */
270 void slotOriginYClicked();
272 /** @brief Updates coordinates of text fields if necessary.
274 * It's called when something changes in the QGraphicsScene. */
277 /** @param valueType of type ValueType */
278 void slotValueChanged(int valueType);
280 void slotZoom(bool up);
281 void slotUpdateZoom(int pos);
282 void slotAdjustZoom();
283 void slotZoomOneToOne();
285 void slotUpdateText();
286 void slotInsertUnicode();
287 void slotInsertUnicodeString(QString);
289 void displayBackgroundFrame();
291 void setCurrentItem(QGraphicsItem *item);
295 void slotSelectTool();
296 void slotImageTool();
298 void slotAnimStart(bool);
299 void slotAnimEnd(bool);
300 void slotKeepAspect(bool keep);
309 void slotResize100();
310 void slotResize200();
312 /** @brief Called when accepted, stores user selections for next time use.
313 * @ref writeChoices */
316 void slotFontText(const QString& s);
318 /** @brief Adds an effect to an element.
319 * @param ix index of the effect in the effects menu
321 * The current implementation allows for one QGraphicsEffect to be added
322 * along with the typewriter effect. This is not clear to the user: the
323 * stack would help, and would permit us to make more QGraphicsEffects
324 * coexist (with different layers of QGraphicsItems). */
325 void slotAddEffect(int ix);
326 void slotEditBlur(int ix);
327 void slotEditShadow();
328 void slotEditTypewriter(int ix);
330 /** @brief Changes the Z index of objects. */
332 void slotZIndexDown();
333 void slotZIndexTop();
334 void slotZIndexBottom();
335 void templateIndexChanged(int);