1073 lines
55 KiB
HTML
1073 lines
55 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.15"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Olive: OliveGlobal Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Olive
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.15 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-slots">Public Slots</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pri-methods">Private Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="class_olive_global-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">OliveGlobal Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>The Olive Global class.
|
|
<a href="class_olive_global.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="oliveglobal_8h_source.html">oliveglobal.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for OliveGlobal:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_olive_global.png" alt=""/>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-slots"></a>
|
|
Public Slots</h2></td></tr>
|
|
<tr class="memitem:ac5c7fc8e77040c8260e2e817e3e7b165"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#ac5c7fc8e77040c8260e2e817e3e7b165">undo</a> ()</td></tr>
|
|
<tr class="memdesc:ac5c7fc8e77040c8260e2e817e3e7b165"><td class="mdescLeft"> </td><td class="mdescRight">Undo user's last action. <a href="#ac5c7fc8e77040c8260e2e817e3e7b165">More...</a><br /></td></tr>
|
|
<tr class="separator:ac5c7fc8e77040c8260e2e817e3e7b165"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a501c01aa8f27966ea6fc4c3b74ee8a17"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#a501c01aa8f27966ea6fc4c3b74ee8a17">redo</a> ()</td></tr>
|
|
<tr class="memdesc:a501c01aa8f27966ea6fc4c3b74ee8a17"><td class="mdescLeft"> </td><td class="mdescRight">Redo user's last action. <a href="#a501c01aa8f27966ea6fc4c3b74ee8a17">More...</a><br /></td></tr>
|
|
<tr class="separator:a501c01aa8f27966ea6fc4c3b74ee8a17"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8574a0c2c68978756671d0289ca9e8ff"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#a8574a0c2c68978756671d0289ca9e8ff">paste</a> ()</td></tr>
|
|
<tr class="memdesc:a8574a0c2c68978756671d0289ca9e8ff"><td class="mdescLeft"> </td><td class="mdescRight">Paste contents of clipboard. <a href="#a8574a0c2c68978756671d0289ca9e8ff">More...</a><br /></td></tr>
|
|
<tr class="separator:a8574a0c2c68978756671d0289ca9e8ff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6f6f44ef9503d674851b761c927e8154"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#a6f6f44ef9503d674851b761c927e8154">paste_insert</a> ()</td></tr>
|
|
<tr class="memdesc:a6f6f44ef9503d674851b761c927e8154"><td class="mdescLeft"> </td><td class="mdescRight">Paste contents of clipboard, making space for it when possible. <a href="#a6f6f44ef9503d674851b761c927e8154">More...</a><br /></td></tr>
|
|
<tr class="separator:a6f6f44ef9503d674851b761c927e8154"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a96005523cb0a1ba0c4647ce2f2791331"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#a96005523cb0a1ba0c4647ce2f2791331">new_project</a> ()</td></tr>
|
|
<tr class="memdesc:a96005523cb0a1ba0c4647ce2f2791331"><td class="mdescLeft"> </td><td class="mdescRight">Create new project. <a href="#a96005523cb0a1ba0c4647ce2f2791331">More...</a><br /></td></tr>
|
|
<tr class="separator:a96005523cb0a1ba0c4647ce2f2791331"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaa945027c0f85fe2b65ad7be5997e02f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#aaa945027c0f85fe2b65ad7be5997e02f">open_project</a> ()</td></tr>
|
|
<tr class="memdesc:aaa945027c0f85fe2b65ad7be5997e02f"><td class="mdescLeft"> </td><td class="mdescRight">Open a project from file. <a href="#aaa945027c0f85fe2b65ad7be5997e02f">More...</a><br /></td></tr>
|
|
<tr class="separator:aaa945027c0f85fe2b65ad7be5997e02f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7eaad3e9ab9637f48f2a3cbcb1628a42"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#a7eaad3e9ab9637f48f2a3cbcb1628a42">open_recent</a> (int index)</td></tr>
|
|
<tr class="memdesc:a7eaad3e9ab9637f48f2a3cbcb1628a42"><td class="mdescLeft"> </td><td class="mdescRight">Open recent project from list. <a href="#a7eaad3e9ab9637f48f2a3cbcb1628a42">More...</a><br /></td></tr>
|
|
<tr class="separator:a7eaad3e9ab9637f48f2a3cbcb1628a42"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab3f5f0874214f7ecac66d7ab152a8141"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#ab3f5f0874214f7ecac66d7ab152a8141">save_project_as</a> ()</td></tr>
|
|
<tr class="memdesc:ab3f5f0874214f7ecac66d7ab152a8141"><td class="mdescLeft"> </td><td class="mdescRight">Shows a save file dialog and saves the project as the resulting filename. <a href="#ab3f5f0874214f7ecac66d7ab152a8141">More...</a><br /></td></tr>
|
|
<tr class="separator:ab3f5f0874214f7ecac66d7ab152a8141"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a465ffe390d9b615ed8216d2335039197"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#a465ffe390d9b615ed8216d2335039197">save_project</a> ()</td></tr>
|
|
<tr class="memdesc:a465ffe390d9b615ed8216d2335039197"><td class="mdescLeft"> </td><td class="mdescRight">Saves the current project to file. <a href="#a465ffe390d9b615ed8216d2335039197">More...</a><br /></td></tr>
|
|
<tr class="separator:a465ffe390d9b615ed8216d2335039197"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a634b935875324ef89ac8088b10a8707f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#a634b935875324ef89ac8088b10a8707f">can_close_project</a> ()</td></tr>
|
|
<tr class="memdesc:a634b935875324ef89ac8088b10a8707f"><td class="mdescLeft"> </td><td class="mdescRight">Determine whether the current project can be closed. <a href="#a634b935875324ef89ac8088b10a8707f">More...</a><br /></td></tr>
|
|
<tr class="separator:a634b935875324ef89ac8088b10a8707f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abb20f21708320f258d99a2737640129e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#abb20f21708320f258d99a2737640129e">open_export_dialog</a> ()</td></tr>
|
|
<tr class="memdesc:abb20f21708320f258d99a2737640129e"><td class="mdescLeft"> </td><td class="mdescRight">Open the Export dialog to trigger an export of the current sequence. <a href="#abb20f21708320f258d99a2737640129e">More...</a><br /></td></tr>
|
|
<tr class="separator:abb20f21708320f258d99a2737640129e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a161a4b6f88441f82f0e90331f39044fb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#a161a4b6f88441f82f0e90331f39044fb">open_about_dialog</a> ()</td></tr>
|
|
<tr class="memdesc:a161a4b6f88441f82f0e90331f39044fb"><td class="mdescLeft"> </td><td class="mdescRight">Open the About Olive dialog. <a href="#a161a4b6f88441f82f0e90331f39044fb">More...</a><br /></td></tr>
|
|
<tr class="separator:a161a4b6f88441f82f0e90331f39044fb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0c142bf5d9f0ab9753154b3926b08d37"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#a0c142bf5d9f0ab9753154b3926b08d37">open_debug_log</a> ()</td></tr>
|
|
<tr class="memdesc:a0c142bf5d9f0ab9753154b3926b08d37"><td class="mdescLeft"> </td><td class="mdescRight">Open the Debug Log window. <a href="#a0c142bf5d9f0ab9753154b3926b08d37">More...</a><br /></td></tr>
|
|
<tr class="separator:a0c142bf5d9f0ab9753154b3926b08d37"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abc5fb406d67e5f62602b3806fcab04f2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#abc5fb406d67e5f62602b3806fcab04f2">open_speed_dialog</a> ()</td></tr>
|
|
<tr class="memdesc:abc5fb406d67e5f62602b3806fcab04f2"><td class="mdescLeft"> </td><td class="mdescRight">Open the Speed/Duration dialog. <a href="#abc5fb406d67e5f62602b3806fcab04f2">More...</a><br /></td></tr>
|
|
<tr class="separator:abc5fb406d67e5f62602b3806fcab04f2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9a255c3b943eca104abb777243d32dee"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#a9a255c3b943eca104abb777243d32dee">open_action_search</a> ()</td></tr>
|
|
<tr class="memdesc:a9a255c3b943eca104abb777243d32dee"><td class="mdescLeft"> </td><td class="mdescRight">Open the Action Search overlay. <a href="#a9a255c3b943eca104abb777243d32dee">More...</a><br /></td></tr>
|
|
<tr class="separator:a9a255c3b943eca104abb777243d32dee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a097586341c27234802fb42f7ee1d40c6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#a097586341c27234802fb42f7ee1d40c6">clear_undo_stack</a> ()</td></tr>
|
|
<tr class="memdesc:a097586341c27234802fb42f7ee1d40c6"><td class="mdescLeft"> </td><td class="mdescRight">Clears the current undo stack. <a href="#a097586341c27234802fb42f7ee1d40c6">More...</a><br /></td></tr>
|
|
<tr class="separator:a097586341c27234802fb42f7ee1d40c6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a60dbd750a5eedea296cbe40bc8d4051e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#a60dbd750a5eedea296cbe40bc8d4051e">finished_initialize</a> ()</td></tr>
|
|
<tr class="memdesc:a60dbd750a5eedea296cbe40bc8d4051e"><td class="mdescLeft"> </td><td class="mdescRight">Function called when Olive has finished starting up. <a href="#a60dbd750a5eedea296cbe40bc8d4051e">More...</a><br /></td></tr>
|
|
<tr class="separator:a60dbd750a5eedea296cbe40bc8d4051e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a683bdbe17929ce90db233a3cdff8fc30"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#a683bdbe17929ce90db233a3cdff8fc30">save_autorecovery_file</a> ()</td></tr>
|
|
<tr class="memdesc:a683bdbe17929ce90db233a3cdff8fc30"><td class="mdescLeft"> </td><td class="mdescRight">Save an auto-recovery file of the current project. <a href="#a683bdbe17929ce90db233a3cdff8fc30">More...</a><br /></td></tr>
|
|
<tr class="separator:a683bdbe17929ce90db233a3cdff8fc30"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a481765a0b424ca37c50326dbe97fb204"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#a481765a0b424ca37c50326dbe97fb204">open_preferences</a> ()</td></tr>
|
|
<tr class="memdesc:a481765a0b424ca37c50326dbe97fb204"><td class="mdescLeft"> </td><td class="mdescRight">Opens the Preferences dialog. <a href="#a481765a0b424ca37c50326dbe97fb204">More...</a><br /></td></tr>
|
|
<tr class="separator:a481765a0b424ca37c50326dbe97fb204"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a8ee567e30178cd747396c6222970de1b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#a8ee567e30178cd747396c6222970de1b">OliveGlobal</a> ()</td></tr>
|
|
<tr class="memdesc:a8ee567e30178cd747396c6222970de1b"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="class_olive_global.html" title="The Olive Global class.">OliveGlobal</a> Constructor. <a href="#a8ee567e30178cd747396c6222970de1b">More...</a><br /></td></tr>
|
|
<tr class="separator:a8ee567e30178cd747396c6222970de1b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac57ead290b6cf9895aa11a1200d7c397"><td class="memItemLeft" align="right" valign="top">const QString & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#ac57ead290b6cf9895aa11a1200d7c397">get_project_file_filter</a> ()</td></tr>
|
|
<tr class="memdesc:ac57ead290b6cf9895aa11a1200d7c397"><td class="mdescLeft"> </td><td class="mdescRight">Returns the file dialog filter used when interfacing with Olive project files. <a href="#ac57ead290b6cf9895aa11a1200d7c397">More...</a><br /></td></tr>
|
|
<tr class="separator:ac57ead290b6cf9895aa11a1200d7c397"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af3ef4cb94078beb905eb916a160fe826"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#af3ef4cb94078beb905eb916a160fe826">update_project_filename</a> (const QString &s)</td></tr>
|
|
<tr class="memdesc:af3ef4cb94078beb905eb916a160fe826"><td class="mdescLeft"> </td><td class="mdescRight">Change the current active project filename. <a href="#af3ef4cb94078beb905eb916a160fe826">More...</a><br /></td></tr>
|
|
<tr class="separator:af3ef4cb94078beb905eb916a160fe826"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aed575061a3669d27854f76b3af599846"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#aed575061a3669d27854f76b3af599846">check_for_autorecovery_file</a> ()</td></tr>
|
|
<tr class="memdesc:aed575061a3669d27854f76b3af599846"><td class="mdescLeft"> </td><td class="mdescRight">Check whether an auto-recovery file exists and ask the user if they want to load it. <a href="#aed575061a3669d27854f76b3af599846">More...</a><br /></td></tr>
|
|
<tr class="separator:aed575061a3669d27854f76b3af599846"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2763e87021f250965f67e175ee6c6e67"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#a2763e87021f250965f67e175ee6c6e67">set_rendering_state</a> (bool rendering)</td></tr>
|
|
<tr class="memdesc:a2763e87021f250965f67e175ee6c6e67"><td class="mdescLeft"> </td><td class="mdescRight">Set the application state depending on if the user is exporting a video. <a href="#a2763e87021f250965f67e175ee6c6e67">More...</a><br /></td></tr>
|
|
<tr class="separator:a2763e87021f250965f67e175ee6c6e67"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a457ad9d7f5d716b0f23a7aa01187da5d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#a457ad9d7f5d716b0f23a7aa01187da5d">load_project_on_launch</a> (const QString &s)</td></tr>
|
|
<tr class="memdesc:a457ad9d7f5d716b0f23a7aa01187da5d"><td class="mdescLeft"> </td><td class="mdescRight">Set a project to load just after launching. <a href="#a457ad9d7f5d716b0f23a7aa01187da5d">More...</a><br /></td></tr>
|
|
<tr class="separator:a457ad9d7f5d716b0f23a7aa01187da5d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acf4fdfadaf62290f28de49c12d58cb5b"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#acf4fdfadaf62290f28de49c12d58cb5b">get_recent_project_list_file</a> ()</td></tr>
|
|
<tr class="memdesc:acf4fdfadaf62290f28de49c12d58cb5b"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the URL of the config file containing the autorecovery projects. <a href="#acf4fdfadaf62290f28de49c12d58cb5b">More...</a><br /></td></tr>
|
|
<tr class="separator:acf4fdfadaf62290f28de49c12d58cb5b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a253062054141283225131ba1c4cdc345"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#a253062054141283225131ba1c4cdc345">load_translation_from_config</a> ()</td></tr>
|
|
<tr class="memdesc:a253062054141283225131ba1c4cdc345"><td class="mdescLeft"> </td><td class="mdescRight">(Re)load translation file from olive::config <a href="#a253062054141283225131ba1c4cdc345">More...</a><br /></td></tr>
|
|
<tr class="separator:a253062054141283225131ba1c4cdc345"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
|
|
Private Member Functions</h2></td></tr>
|
|
<tr class="memitem:a59e4870f994af018fb71d3871872fd7e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#a59e4870f994af018fb71d3871872fd7e">open_project_worker</a> (const QString &fn, bool autorecovery)</td></tr>
|
|
<tr class="memdesc:a59e4870f994af018fb71d3871872fd7e"><td class="mdescLeft"> </td><td class="mdescRight">Internal function to handle loading a project from file. <a href="#a59e4870f994af018fb71d3871872fd7e">More...</a><br /></td></tr>
|
|
<tr class="separator:a59e4870f994af018fb71d3871872fd7e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
|
|
Private Attributes</h2></td></tr>
|
|
<tr class="memitem:a053f4de79194655e0a51b538e0bb0d95"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#a053f4de79194655e0a51b538e0bb0d95">project_file_filter</a></td></tr>
|
|
<tr class="memdesc:a053f4de79194655e0a51b538e0bb0d95"><td class="mdescLeft"> </td><td class="mdescRight">File filter used for any file dialogs relating to Olive project files. <a href="#a053f4de79194655e0a51b538e0bb0d95">More...</a><br /></td></tr>
|
|
<tr class="separator:a053f4de79194655e0a51b538e0bb0d95"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a78f108b6ed6a5a7f13a69f51038bb2b5"><td class="memItemLeft" align="right" valign="top">QTimer </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#a78f108b6ed6a5a7f13a69f51038bb2b5">autorecovery_timer</a></td></tr>
|
|
<tr class="memdesc:a78f108b6ed6a5a7f13a69f51038bb2b5"><td class="mdescLeft"> </td><td class="mdescRight">Regular interval to save an auto-recovery project. <a href="#a78f108b6ed6a5a7f13a69f51038bb2b5">More...</a><br /></td></tr>
|
|
<tr class="separator:a78f108b6ed6a5a7f13a69f51038bb2b5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a41a11e816954dbc44e2b24c1d7fe0398"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#a41a11e816954dbc44e2b24c1d7fe0398">enable_load_project_on_init</a></td></tr>
|
|
<tr class="memdesc:a41a11e816954dbc44e2b24c1d7fe0398"><td class="mdescLeft"> </td><td class="mdescRight">Internal variable set to <b>TRUE</b> by <a class="el" href="main_8cpp.html#a0ddf1224851353fc92bfbff6f499fa97">main()</a> if a project file was set as an argument. <a href="#a41a11e816954dbc44e2b24c1d7fe0398">More...</a><br /></td></tr>
|
|
<tr class="separator:a41a11e816954dbc44e2b24c1d7fe0398"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a169a70f162ce78741c41ae14bf6c88bc"><td class="memItemLeft" align="right" valign="top">std::unique_ptr< QTranslator > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_olive_global.html#a169a70f162ce78741c41ae14bf6c88bc">translator</a></td></tr>
|
|
<tr class="memdesc:a169a70f162ce78741c41ae14bf6c88bc"><td class="mdescLeft"> </td><td class="mdescRight">Internal translator object that interfaces with the currently loaded language file. <a href="#a169a70f162ce78741c41ae14bf6c88bc">More...</a><br /></td></tr>
|
|
<tr class="separator:a169a70f162ce78741c41ae14bf6c88bc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>The Olive Global class. </p>
|
|
<p>A resource for various global functions used throughout Olive. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a8ee567e30178cd747396c6222970de1b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8ee567e30178cd747396c6222970de1b">◆ </a></span>OliveGlobal()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">OliveGlobal::OliveGlobal </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p><a class="el" href="class_olive_global.html" title="The Olive Global class.">OliveGlobal</a> Constructor. </p>
|
|
<p>Creates Olive Global object. Also sets some default runtime settings and the application name. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a634b935875324ef89ac8088b10a8707f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a634b935875324ef89ac8088b10a8707f">◆ </a></span>can_close_project</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool OliveGlobal::can_close_project </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Determine whether the current project can be closed. </p>
|
|
<p>Queried any time the current project is going to be closed (e.g. starting a new project, loading a project, exiting Olive, etc.) If the project has unsaved changes, this function asks the user whether they want to save or not. If the user does, calls <a class="el" href="class_olive_global.html#a465ffe390d9b615ed8216d2335039197" title="Saves the current project to file.">save_project()</a> (which may in turn call <a class="el" href="class_olive_global.html#ab3f5f0874214f7ecac66d7ab152a8141" title="Shows a save file dialog and saves the project as the resulting filename.">save_project_as()</a> if the project has never been saved).</p>
|
|
<dl class="section return"><dt>Returns</dt><dd><b>TRUE</b> if the project can be closed. FALSE if not. If the project does NOT have unsaved changes, always returns <b>TRUE</b>. If it does and the user clicks YES, this returns the result of <a class="el" href="class_olive_global.html#a465ffe390d9b615ed8216d2335039197" title="Saves the current project to file.">save_project()</a>. If the user clicks NO, this returns <b>TRUE</b>. If the user clicks CANCEL, this returns <b>FALSE</b>. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aed575061a3669d27854f76b3af599846"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aed575061a3669d27854f76b3af599846">◆ </a></span>check_for_autorecovery_file()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OliveGlobal::check_for_autorecovery_file </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check whether an auto-recovery file exists and ask the user if they want to load it. </p>
|
|
<p>Usually called on initialization. Checks if an auto-recovery file exists (meaning the last session of Olive didn't close correctly). If it finds one, asks the user if they want to load it. If so, loads the auto-recovery project. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a097586341c27234802fb42f7ee1d40c6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a097586341c27234802fb42f7ee1d40c6">◆ </a></span>clear_undo_stack</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OliveGlobal::clear_undo_stack </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clears the current undo stack. </p>
|
|
<p>Clears all current commands in the undo stack. Mostly used for debugging. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a60dbd750a5eedea296cbe40bc8d4051e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a60dbd750a5eedea296cbe40bc8d4051e">◆ </a></span>finished_initialize</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OliveGlobal::finished_initialize </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Function called when Olive has finished starting up. </p>
|
|
<p>Sets up some last things for Olive that must be run after Olive has completed initialization. If a project was loaded as a command line argument, it's loaded here. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac57ead290b6cf9895aa11a1200d7c397"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac57ead290b6cf9895aa11a1200d7c397">◆ </a></span>get_project_file_filter()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const QString & OliveGlobal::get_project_file_filter </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns the file dialog filter used when interfacing with Olive project files. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The file filter string used by QFileDialog to limit the files shown to Olive (*.ove) files. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acf4fdfadaf62290f28de49c12d58cb5b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acf4fdfadaf62290f28de49c12d58cb5b">◆ </a></span>get_recent_project_list_file()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString OliveGlobal::get_recent_project_list_file </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieves the URL of the config file containing the autorecovery projects. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The URL as a string </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a457ad9d7f5d716b0f23a7aa01187da5d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a457ad9d7f5d716b0f23a7aa01187da5d">◆ </a></span>load_project_on_launch()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OliveGlobal::load_project_on_launch </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const QString & </td>
|
|
<td class="paramname"><em>s</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set a project to load just after launching. </p>
|
|
<p>Called by <a class="el" href="main_8cpp.html#a0ddf1224851353fc92bfbff6f499fa97">main()</a> if Olive was called with a project file as a running argument. Sets up Olive to load the specified project once its finished initializing.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">s</td><td>The URL of the project file to load. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a253062054141283225131ba1c4cdc345"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a253062054141283225131ba1c4cdc345">◆ </a></span>load_translation_from_config()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OliveGlobal::load_translation_from_config </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>(Re)load translation file from olive::config </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a96005523cb0a1ba0c4647ce2f2791331"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a96005523cb0a1ba0c4647ce2f2791331">◆ </a></span>new_project</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OliveGlobal::new_project </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Create new project. </p>
|
|
<p>Confirms whether the current project can be closed, and if so, clears all current project data and resets program state. Standard <code>File > New</code> behavior. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a161a4b6f88441f82f0e90331f39044fb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a161a4b6f88441f82f0e90331f39044fb">◆ </a></span>open_about_dialog</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OliveGlobal::open_about_dialog </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Open the About Olive dialog. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9a255c3b943eca104abb777243d32dee"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9a255c3b943eca104abb777243d32dee">◆ </a></span>open_action_search</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OliveGlobal::open_action_search </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Open the Action Search overlay. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0c142bf5d9f0ab9753154b3926b08d37"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0c142bf5d9f0ab9753154b3926b08d37">◆ </a></span>open_debug_log</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OliveGlobal::open_debug_log </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Open the Debug Log window. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abb20f21708320f258d99a2737640129e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abb20f21708320f258d99a2737640129e">◆ </a></span>open_export_dialog</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OliveGlobal::open_export_dialog </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Open the Export dialog to trigger an export of the current sequence. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a481765a0b424ca37c50326dbe97fb204"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a481765a0b424ca37c50326dbe97fb204">◆ </a></span>open_preferences</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OliveGlobal::open_preferences </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Opens the Preferences dialog. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaa945027c0f85fe2b65ad7be5997e02f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaa945027c0f85fe2b65ad7be5997e02f">◆ </a></span>open_project</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OliveGlobal::open_project </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Open a project from file. </p>
|
|
<p>Confirms whether the current project can be closed, and if so, shows an open file dialog to allow the user to select a project file and then triggers a project load with it. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a59e4870f994af018fb71d3871872fd7e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a59e4870f994af018fb71d3871872fd7e">◆ </a></span>open_project_worker()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OliveGlobal::open_project_worker </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const QString & </td>
|
|
<td class="paramname"><em>fn</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>autorecovery</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Internal function to handle loading a project from file. </p>
|
|
<p>Start loading a project. Doesn't check if the current project can be closed, doesn't check if the project exists. In most cases, you'll want <a class="el" href="class_olive_global.html#aaa945027c0f85fe2b65ad7be5997e02f" title="Open a project from file.">open_project()</a> to be end-user friendly.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fn</td><td>The URL to the project to load.</td></tr>
|
|
<tr><td class="paramname">autorecovery</td><td>Whether this file is an autorecovery file. If it is, after the load Olive will set the project URL to a new file beside the original project file so that it does not overwrite the original and so that the user is not working on the autorecovery project in Olive's application data directory. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7eaad3e9ab9637f48f2a3cbcb1628a42"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7eaad3e9ab9637f48f2a3cbcb1628a42">◆ </a></span>open_recent</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OliveGlobal::open_recent </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>index</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Open recent project from list. </p>
|
|
<p>Triggers a project load from the internal recent projects list.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">index</td><td>Index in the list of the project fille to load </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abc5fb406d67e5f62602b3806fcab04f2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abc5fb406d67e5f62602b3806fcab04f2">◆ </a></span>open_speed_dialog</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OliveGlobal::open_speed_dialog </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Open the Speed/Duration dialog. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8574a0c2c68978756671d0289ca9e8ff"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8574a0c2c68978756671d0289ca9e8ff">◆ </a></span>paste</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OliveGlobal::paste </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Paste contents of clipboard. </p>
|
|
<p>Pastes contents of clipboard. Seeing as several types of data can be copied into the clipboard, this function will automatically determine what type of data is in the clipboard and paste it in the correct location (e.g. clip data will go to the <a class="el" href="class_timeline.html">Timeline</a>, effect data will go to <a class="el" href="class_effect.html">Effect</a> Controls). </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6f6f44ef9503d674851b761c927e8154"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6f6f44ef9503d674851b761c927e8154">◆ </a></span>paste_insert</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OliveGlobal::paste_insert </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Paste contents of clipboard, making space for it when possible. </p>
|
|
<p>Pastes contents of clipboard (same as <a class="el" href="class_olive_global.html#a8574a0c2c68978756671d0289ca9e8ff" title="Paste contents of clipboard.">paste()</a>). If the clipboard contains clip data, the clips are cut at the current playhead and ripple forward to make space for the clips in the clipboard. Can be considered semi-non-destructive as a result (as opposed to <a class="el" href="class_olive_global.html#a8574a0c2c68978756671d0289ca9e8ff" title="Paste contents of clipboard.">paste()</a> overwriting clips). If the clipboard contains effect data, the functionality is identical to <a class="el" href="class_olive_global.html#a8574a0c2c68978756671d0289ca9e8ff" title="Paste contents of clipboard.">paste()</a>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a501c01aa8f27966ea6fc4c3b74ee8a17"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a501c01aa8f27966ea6fc4c3b74ee8a17">◆ </a></span>redo</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OliveGlobal::redo </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Redo user's last action. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a683bdbe17929ce90db233a3cdff8fc30"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a683bdbe17929ce90db233a3cdff8fc30">◆ </a></span>save_autorecovery_file</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OliveGlobal::save_autorecovery_file </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Save an auto-recovery file of the current project. </p>
|
|
<p>Call this function to save the current state of the project as an auto-recovery project. Called regularly by <code>autorecovery_timer</code>. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a465ffe390d9b615ed8216d2335039197"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a465ffe390d9b615ed8216d2335039197">◆ </a></span>save_project</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool OliveGlobal::save_project </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Saves the current project to file. </p>
|
|
<p>If the project has been saved already, this function will overwrite the project file with the current project data. Calls <a class="el" href="class_olive_global.html#ab3f5f0874214f7ecac66d7ab152a8141" title="Shows a save file dialog and saves the project as the resulting filename.">save_project_as()</a> if the file has not been saved before.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd><b>TRUE</b> if the project has been saved before and was successfully overwritten. Otherwise returns the value of <a class="el" href="class_olive_global.html#ab3f5f0874214f7ecac66d7ab152a8141" title="Shows a save file dialog and saves the project as the resulting filename.">save_project_as()</a>. Useful if the user closing an unsaved project, clicks "Yes" to save, we know if they actually saved or not and won't continue closing the project if they didn't. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab3f5f0874214f7ecac66d7ab152a8141"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab3f5f0874214f7ecac66d7ab152a8141">◆ </a></span>save_project_as</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool OliveGlobal::save_project_as </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Shows a save file dialog and saves the project as the resulting filename. </p>
|
|
<p>Shows a save file dialog for the user to save their current project as a different filename from the current one. Also triggered by <a class="el" href="class_olive_global.html#a465ffe390d9b615ed8216d2335039197" title="Saves the current project to file.">save_project()</a> if the file hasn't been saved yet.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd><b>TRUE</b> if the user saved the project. <b>FALSE</b> if they cancelled out of the save file dialog. Useful if a user is closing an unsaved project, clicks "Yes" to save, we know if they actually saved or not and won't continue closing the project if they didn't. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2763e87021f250965f67e175ee6c6e67"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2763e87021f250965f67e175ee6c6e67">◆ </a></span>set_rendering_state()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OliveGlobal::set_rendering_state </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>rendering</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the application state depending on if the user is exporting a video. </p>
|
|
<p>Some background functions shouldn't run while Olive is exporting a video. This function will disable/enable them as necessary.</p>
|
|
<p>The current functions are as follows:</p><ul>
|
|
<li>Auto-recovery interval. Olive saves an auto-recovery just before exporting anyway and seeing as the user cannot make changes while rendering, there's no reason to continue saving auto-recovery files.</li>
|
|
<li>Audio device playback. Olive uses the same internal audio buffer for exporting as it does for playback, but this buffer does not need to be forwarded to the output device when exporting.</li>
|
|
</ul>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">rendering</td><td><b>TRUE</b> if Olive is about to export a video. <b>FALSE</b> if Olive has finished exporting. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac5c7fc8e77040c8260e2e817e3e7b165"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac5c7fc8e77040c8260e2e817e3e7b165">◆ </a></span>undo</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OliveGlobal::undo </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Undo user's last action. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af3ef4cb94078beb905eb916a160fe826"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af3ef4cb94078beb905eb916a160fe826">◆ </a></span>update_project_filename()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void OliveGlobal::update_project_filename </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const QString & </td>
|
|
<td class="paramname"><em>s</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Change the current active project filename. </p>
|
|
<p>Triggered to change the current active project filename. Call this before calling any internal project saving or loading functions in order to set which file to work with (<a class="el" href="class_olive_global.html#aaa945027c0f85fe2b65ad7be5997e02f" title="Open a project from file.">OliveGlobal::open_project()</a> and <a class="el" href="class_olive_global.html#ab3f5f0874214f7ecac66d7ab152a8141" title="Shows a save file dialog and saves the project as the resulting filename.">OliveGlobal::save_project_as()</a> do this automatically). Also updates the main window title to reflect the project filename.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">s</td><td>The URL of the project file to work with. Can be an empty string, in which case Olive will treat the project as an unsaved project. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a78f108b6ed6a5a7f13a69f51038bb2b5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a78f108b6ed6a5a7f13a69f51038bb2b5">◆ </a></span>autorecovery_timer</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QTimer OliveGlobal::autorecovery_timer</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Regular interval to save an auto-recovery project. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a41a11e816954dbc44e2b24c1d7fe0398"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a41a11e816954dbc44e2b24c1d7fe0398">◆ </a></span>enable_load_project_on_init</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool OliveGlobal::enable_load_project_on_init</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Internal variable set to <b>TRUE</b> by <a class="el" href="main_8cpp.html#a0ddf1224851353fc92bfbff6f499fa97">main()</a> if a project file was set as an argument. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a053f4de79194655e0a51b538e0bb0d95"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a053f4de79194655e0a51b538e0bb0d95">◆ </a></span>project_file_filter</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString OliveGlobal::project_file_filter</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>File filter used for any file dialogs relating to Olive project files. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a169a70f162ce78741c41ae14bf6c88bc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a169a70f162ce78741c41ae14bf6c88bc">◆ </a></span>translator</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::unique_ptr<QTranslator> OliveGlobal::translator</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Internal translator object that interfaces with the currently loaded language file. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li><a class="el" href="oliveglobal_8h_source.html">oliveglobal.h</a></li>
|
|
<li><a class="el" href="oliveglobal_8cpp.html">oliveglobal.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.15
|
|
</small></address>
|
|
</body>
|
|
</html>
|