<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.9.1"/> <title>Helix Web Services Client: hws/SyncProject.h Source File</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> <script type="text/javascript"> $(document).ready(function() { init_search(); }); </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 style="padding-left: 0.5em;"> <div id="projectname">Helix Web Services Client  <span id="projectnumber">1</span> </div> <div id="projectbrief">Helix Web Services Client SDK for Qt Applications</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.9.1 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> </ul> </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 id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_df4b35d643e8581cc301a008445d7803.html">hws</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">SyncProject.h</div> </div> </div><!--header--> <div class="contents"> <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef __HWS_SYNC_PROJECT_H__</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define __HWS_SYNC_PROJECT_H__</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div> <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include <QJsonObject></span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <QString></span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include <QSharedPointer></span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include <QUrl></span></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "Project.h"</span></div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">namespace </span><a class="code" href="namespacehws.html">hws</a></div> <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> {</div> <div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classhws_1_1_sync_project.html"> 21</a></span>  <span class="keyword">class </span><a class="code" href="classhws_1_1_sync_project.html">SyncProject</a></div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  {</div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="keyword">public</span>:</div> <div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="classhws_1_1_sync_project.html#a884182434301c5e07fdadc74f07026cd"> 25</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> QString <a class="code" href="classhws_1_1_sync_project.html#a884182434301c5e07fdadc74f07026cd">CONTENT_TYPE</a>;</div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <a class="code" href="classhws_1_1_sync_project.html#a5e51a0776d83f3177c61b74b82450530">SyncProject</a>(<span class="keyword">const</span> <a class="code" href="classhws_1_1_project.html">Project</a> & <a class="code" href="classhws_1_1_sync_project.html#af0343da2719dc861ba999bc9b72c87fd">project</a>);</div> <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <a class="code" href="classhws_1_1_sync_project.html#a5e51a0776d83f3177c61b74b82450530">SyncProject</a>();</div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <a class="code" href="classhws_1_1_sync_project.html#a5e51a0776d83f3177c61b74b82450530">SyncProject</a>(<span class="keyword">const</span> <a class="code" href="classhws_1_1_sync_project.html">SyncProject</a> & p);</div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <a class="code" href="classhws_1_1_sync_project.html">SyncProject</a> & <a class="code" href="classhws_1_1_sync_project.html#ab06f04b0165c77b843e598946adf3f2e">operator=</a>(<span class="keyword">const</span> <a class="code" href="classhws_1_1_sync_project.html">SyncProject</a> & p);</div> <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div> <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  ~<a class="code" href="classhws_1_1_sync_project.html">SyncProject</a>();</div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">const</span> <a class="code" href="classhws_1_1_project.html">Project</a> & <a class="code" href="classhws_1_1_sync_project.html#af0343da2719dc861ba999bc9b72c87fd">project</a>() <span class="keyword">const</span>;</div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="classhws_1_1_project.html">Project</a> & <a class="code" href="classhws_1_1_sync_project.html#af0343da2719dc861ba999bc9b72c87fd">project</a>();</div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  QString <a class="code" href="classhws_1_1_sync_project.html#ac60dd2b5d094976ac48c6ce23d5f7655">id</a>() <span class="keyword">const</span>;</div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">void</span> <a class="code" href="classhws_1_1_sync_project.html#aa6dea75665ffbc54a96ffe0d62187e1c">setId</a>(<span class="keyword">const</span> QString & <span class="keywordtype">id</span>);</div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  QString <a class="code" href="classhws_1_1_sync_project.html#a0a96a23a1990f33b6faa0905b488bc1f">name</a>() <span class="keyword">const</span>;</div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keywordtype">void</span> <a class="code" href="classhws_1_1_sync_project.html#ade66d286306bb608e7f9c756b20080a4">setName</a>(<span class="keyword">const</span> QString & <a class="code" href="classhws_1_1_sync_project.html#a0a96a23a1990f33b6faa0905b488bc1f">name</a>);</div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div> <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  QUrl <a class="code" href="classhws_1_1_sync_project.html#ac844c792da702ec28e3d8e315a498012">p4</a>() <span class="keyword">const</span>;</div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">void</span> <a class="code" href="classhws_1_1_sync_project.html#a24584026ef09e5ee4e1a6992ff01f49b">setP4</a>(<span class="keyword">const</span> QUrl & <a class="code" href="classhws_1_1_sync_project.html#ac844c792da702ec28e3d8e315a498012">p4</a>);</div> <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div> <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordtype">int</span> <a class="code" href="classhws_1_1_sync_project.html#a2065c852b902eea554101b97abe72867">change</a>() <span class="keyword">const</span>;</div> <div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div> <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordtype">void</span> <a class="code" href="classhws_1_1_sync_project.html#ac0b0cb81b9095ca527e1351c3e319ea0">setChange</a>(<span class="keywordtype">int</span> <a class="code" href="classhws_1_1_sync_project.html#a2065c852b902eea554101b97abe72867">change</a>);</div> <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div> <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  QString <a class="code" href="classhws_1_1_sync_project.html#a5ec2d9caf5cdf0ce771e54f4413a15e9">stream</a>() <span class="keyword">const</span>;</div> <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div> <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keyword">private</span>:</div> <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  QJsonObject extension() <span class="keyword">const</span>;</div> <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordtype">void</span> updateExtension();</div> <div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div> <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <a class="code" href="classhws_1_1_project.html">Project</a> mProject;</div> <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  QJsonObject mExtension;</div> <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  };</div> <div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div> <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keyword">typedef</span> QSharedPointer<SyncProject> SyncProjectPtr;</div> <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div> <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  SyncProjectPtr SyncProjectFromJson(QByteArray json);</div> <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div> <div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keyword">typedef</span> QList<SyncProjectPtr> SyncProjectList;</div> <div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div> <div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keyword">typedef</span> QSharedPointer<SyncProjectList> SyncProjectListPtr;</div> <div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div> <div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="comment">// Returns a list of SyncProjects or null if there's any parsing issue.</span></div> <div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  SyncProjectListPtr SyncProjectListFromJson(QByteArray json);</div> <div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div> <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> }</div> <div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div> <div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="preprocessor">#endif </span><span class="comment">/* __HWS_SYNC_PROJECT_H__ */</span><span class="preprocessor"></span></div> <div class="ttc" id="classhws_1_1_sync_project_html_ac0b0cb81b9095ca527e1351c3e319ea0"><div class="ttname"><a href="classhws_1_1_sync_project.html#ac0b0cb81b9095ca527e1351c3e319ea0">hws::SyncProject::setChange</a></div><div class="ttdeci">void setChange(int change)</div><div class="ttdoc">Update the latest changelist number. </div><div class="ttdef"><b>Definition:</b> SyncProject.cpp:96</div></div> <div class="ttc" id="classhws_1_1_project_html"><div class="ttname"><a href="classhws_1_1_project.html">hws::Project</a></div><div class="ttdoc">This is the generic project model for Perforce projects. </div><div class="ttdef"><b>Definition:</b> Project.h:29</div></div> <div class="ttc" id="classhws_1_1_sync_project_html_a0a96a23a1990f33b6faa0905b488bc1f"><div class="ttname"><a href="classhws_1_1_sync_project.html#a0a96a23a1990f33b6faa0905b488bc1f">hws::SyncProject::name</a></div><div class="ttdeci">QString name() const </div><div class="ttdef"><b>Definition:</b> SyncProject.cpp:58</div></div> <div class="ttc" id="classhws_1_1_sync_project_html_a2065c852b902eea554101b97abe72867"><div class="ttname"><a href="classhws_1_1_sync_project.html#a2065c852b902eea554101b97abe72867">hws::SyncProject::change</a></div><div class="ttdeci">int change() const </div><div class="ttdef"><b>Definition:</b> SyncProject.cpp:91</div></div> <div class="ttc" id="namespacehws_html"><div class="ttname"><a href="namespacehws.html">hws</a></div><div class="ttdef"><b>Definition:</b> hws.h:61</div></div> <div class="ttc" id="classhws_1_1_sync_project_html_aa6dea75665ffbc54a96ffe0d62187e1c"><div class="ttname"><a href="classhws_1_1_sync_project.html#aa6dea75665ffbc54a96ffe0d62187e1c">hws::SyncProject::setId</a></div><div class="ttdeci">void setId(const QString &id)</div><div class="ttdef"><b>Definition:</b> SyncProject.cpp:53</div></div> <div class="ttc" id="classhws_1_1_sync_project_html_a5e51a0776d83f3177c61b74b82450530"><div class="ttname"><a href="classhws_1_1_sync_project.html#a5e51a0776d83f3177c61b74b82450530">hws::SyncProject::SyncProject</a></div><div class="ttdeci">SyncProject()</div><div class="ttdoc">Note that this will create an empty or new project. </div><div class="ttdef"><b>Definition:</b> SyncProject.cpp:10</div></div> <div class="ttc" id="classhws_1_1_sync_project_html_a884182434301c5e07fdadc74f07026cd"><div class="ttname"><a href="classhws_1_1_sync_project.html#a884182434301c5e07fdadc74f07026cd">hws::SyncProject::CONTENT_TYPE</a></div><div class="ttdeci">static const QString CONTENT_TYPE</div><div class="ttdoc">The mime type of the extensions supported by the Phoenix project. </div><div class="ttdef"><b>Definition:</b> SyncProject.h:25</div></div> <div class="ttc" id="classhws_1_1_sync_project_html_ade66d286306bb608e7f9c756b20080a4"><div class="ttname"><a href="classhws_1_1_sync_project.html#ade66d286306bb608e7f9c756b20080a4">hws::SyncProject::setName</a></div><div class="ttdeci">void setName(const QString &name)</div><div class="ttdef"><b>Definition:</b> SyncProject.cpp:63</div></div> <div class="ttc" id="classhws_1_1_sync_project_html_ac844c792da702ec28e3d8e315a498012"><div class="ttname"><a href="classhws_1_1_sync_project.html#ac844c792da702ec28e3d8e315a498012">hws::SyncProject::p4</a></div><div class="ttdeci">QUrl p4() const </div><div class="ttdef"><b>Definition:</b> SyncProject.cpp:80</div></div> <div class="ttc" id="classhws_1_1_sync_project_html_ac60dd2b5d094976ac48c6ce23d5f7655"><div class="ttname"><a href="classhws_1_1_sync_project.html#ac60dd2b5d094976ac48c6ce23d5f7655">hws::SyncProject::id</a></div><div class="ttdeci">QString id() const </div><div class="ttdef"><b>Definition:</b> SyncProject.cpp:48</div></div> <div class="ttc" id="classhws_1_1_sync_project_html"><div class="ttname"><a href="classhws_1_1_sync_project.html">hws::SyncProject</a></div><div class="ttdoc">High-level Project model for Helix Sync that wraps the base Project. </div><div class="ttdef"><b>Definition:</b> SyncProject.h:21</div></div> <div class="ttc" id="classhws_1_1_sync_project_html_af0343da2719dc861ba999bc9b72c87fd"><div class="ttname"><a href="classhws_1_1_sync_project.html#af0343da2719dc861ba999bc9b72c87fd">hws::SyncProject::project</a></div><div class="ttdeci">const Project & project() const </div><div class="ttdef"><b>Definition:</b> SyncProject.cpp:43</div></div> <div class="ttc" id="classhws_1_1_sync_project_html_a24584026ef09e5ee4e1a6992ff01f49b"><div class="ttname"><a href="classhws_1_1_sync_project.html#a24584026ef09e5ee4e1a6992ff01f49b">hws::SyncProject::setP4</a></div><div class="ttdeci">void setP4(const QUrl &p4)</div><div class="ttdef"><b>Definition:</b> SyncProject.cpp:85</div></div> <div class="ttc" id="classhws_1_1_sync_project_html_a5ec2d9caf5cdf0ce771e54f4413a15e9"><div class="ttname"><a href="classhws_1_1_sync_project.html#a5ec2d9caf5cdf0ce771e54f4413a15e9">hws::SyncProject::stream</a></div><div class="ttdeci">QString stream() const </div><div class="ttdef"><b>Definition:</b> SyncProject.cpp:102</div></div> <div class="ttc" id="classhws_1_1_sync_project_html_ab06f04b0165c77b843e598946adf3f2e"><div class="ttname"><a href="classhws_1_1_sync_project.html#ab06f04b0165c77b843e598946adf3f2e">hws::SyncProject::operator=</a></div><div class="ttdeci">SyncProject & operator=(const SyncProject &p)</div><div class="ttdoc">Allow assignment, which mostly copies the state of the other project. </div><div class="ttdef"><b>Definition:</b> SyncProject.cpp:31</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Fri Jun 19 2015 16:38:20 for Helix Web Services Client by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.9.1 </small></address> </body> </html>
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#5 | 15423 | tjuricek |
Revised HWS Qt API. This is a major revision of the API, which removes most of the "typed" data, replacing it with a more generic "executeMethodDone" callback. The main benefit here is to allow the API to interop with different versions of p4d, and not restrict the methods it can call. We may add more helpers in the future. |
||
#4 | 14054 | tjuricek |
Allowing the Qt client to select 'all' vs 'my' projects. Right now, it should default to using "my" projects as a rule. |
||
#3 | 14049 | tjuricek |
Add methods to generate client workspaces for a user. The Qt SDK was updated based on immediate need. Also, add Ruby client SDK documentation to the docs site. Everything is early, but there's *some* reference available at least. |
||
#2 | 14026 | tjuricek | Revise example code on main page of Qt SDK | ||
#1 | 14025 | tjuricek |
Revise Qt SDK to a single 'helix_web_services_client' project. Most references to "Phoenix" have now been removed. Additionally, this is more similar to the other platform client SDKs in Ruby and JavaScript. Documentation via Doxygen is now available, and will be how much of the SDK reference should occur. |