<!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/View.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">View.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_VIEW_H__</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define __HWS_VIEW_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 <QString></span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <QSharedPointer></span></div> <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="keyword">namespace </span><a class="code" href="namespacehws.html">hws</a></div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> {</div> <div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="classhws_1_1_view.html"> 16</a></span>  <span class="keyword">class </span><a class="code" href="classhws_1_1_view.html">View</a></div> <div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  {</div> <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="keyword">public</span>:</div> <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  <a class="code" href="classhws_1_1_view.html#a5df3d3c9a8c8f1bed92cede5f633b4fa">View</a>();</div> <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <a class="code" href="classhws_1_1_view.html#a5df3d3c9a8c8f1bed92cede5f633b4fa">View</a>(<span class="keyword">const</span> QString & <a class="code" href="classhws_1_1_view.html#a23b972f01c920639a1cd1f75f327b9f7">depotPath</a>, <span class="keyword">const</span> QString & <a class="code" href="classhws_1_1_view.html#a0edfaa1e3d8a350c10ad84b06a1b2306">viewPath</a>);</div> <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <a class="code" href="classhws_1_1_view.html#a5df3d3c9a8c8f1bed92cede5f633b4fa">View</a>(<span class="keyword">const</span> <a class="code" href="classhws_1_1_view.html">View</a> & v);</div> <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">virtual</span> <a class="code" href="classhws_1_1_view.html#acbc77fc6c3f2ae55d38b0f6f7e37e44e">~View</a>();</div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div> <div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classhws_1_1_view.html#a23b972f01c920639a1cd1f75f327b9f7"> 33</a></span>  <span class="keyword">const</span> QString & <a class="code" href="classhws_1_1_view.html#a23b972f01c920639a1cd1f75f327b9f7">depotPath</a>()<span class="keyword"> const</span></div> <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword"> </span>{</div> <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="keywordflow">return</span> mDepotPath;</div> <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  }</div> <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div> <div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classhws_1_1_view.html#a5ad522327992e82c7608d98873e40d98"> 39</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classhws_1_1_view.html#a5ad522327992e82c7608d98873e40d98">setDepotPath</a>(<span class="keyword">const</span> QString & path)</div> <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  {</div> <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  mDepotPath = path;</div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  }</div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div> <div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classhws_1_1_view.html#a0edfaa1e3d8a350c10ad84b06a1b2306"> 46</a></span>  <span class="keyword">const</span> QString & <a class="code" href="classhws_1_1_view.html#a0edfaa1e3d8a350c10ad84b06a1b2306">viewPath</a>()<span class="keyword"> const</span></div> <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="keyword"> </span>{</div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordflow">return</span> mViewPath;</div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  }</div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div> <div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classhws_1_1_view.html#a4faf8637d0dcaf28d52154880a28d1b0"> 53</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classhws_1_1_view.html#a4faf8637d0dcaf28d52154880a28d1b0">setViewPath</a>(<span class="keyword">const</span> QString & path)</div> <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  {</div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  mViewPath = path;</div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  }</div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div> <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <a class="code" href="classhws_1_1_view.html">View</a> & <a class="code" href="classhws_1_1_view.html#a0ffa1d5ef2449d1142fcd92894d52658">operator=</a>(<span class="keyword">const</span> <a class="code" href="classhws_1_1_view.html">View</a> & v);</div> <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">private</span>:</div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  QString mDepotPath;</div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  QString mViewPath;</div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  };</div> <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div> <div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="comment">// View instances are likely going to be polymorphic references, so define</span></div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="comment">// this and use the QSharedPointer handle by default.</span></div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">typedef</span> QSharedPointer<View> ViewPtr;</div> <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> }</div> <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div> <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#endif </span><span class="comment">/* __HWS_VIEW_H__ */</span><span class="preprocessor"></span></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_view_html_a0ffa1d5ef2449d1142fcd92894d52658"><div class="ttname"><a href="classhws_1_1_view.html#a0ffa1d5ef2449d1142fcd92894d52658">hws::View::operator=</a></div><div class="ttdeci">View & operator=(const View &v)</div><div class="ttdoc">Copy all values from another View. </div><div class="ttdef"><b>Definition:</b> View.cpp:28</div></div> <div class="ttc" id="classhws_1_1_view_html_a23b972f01c920639a1cd1f75f327b9f7"><div class="ttname"><a href="classhws_1_1_view.html#a23b972f01c920639a1cd1f75f327b9f7">hws::View::depotPath</a></div><div class="ttdeci">const QString & depotPath() const </div><div class="ttdoc">The 'absolute' depot path file specification. </div><div class="ttdef"><b>Definition:</b> View.h:33</div></div> <div class="ttc" id="classhws_1_1_view_html_a5df3d3c9a8c8f1bed92cede5f633b4fa"><div class="ttname"><a href="classhws_1_1_view.html#a5df3d3c9a8c8f1bed92cede5f633b4fa">hws::View::View</a></div><div class="ttdeci">View()</div><div class="ttdoc">Construct a new view with empty paths. </div><div class="ttdef"><b>Definition:</b> View.cpp:6</div></div> <div class="ttc" id="classhws_1_1_view_html_a0edfaa1e3d8a350c10ad84b06a1b2306"><div class="ttname"><a href="classhws_1_1_view.html#a0edfaa1e3d8a350c10ad84b06a1b2306">hws::View::viewPath</a></div><div class="ttdeci">const QString & viewPath() const </div><div class="ttdef"><b>Definition:</b> View.h:46</div></div> <div class="ttc" id="classhws_1_1_view_html_acbc77fc6c3f2ae55d38b0f6f7e37e44e"><div class="ttname"><a href="classhws_1_1_view.html#acbc77fc6c3f2ae55d38b0f6f7e37e44e">hws::View::~View</a></div><div class="ttdeci">virtual ~View()</div><div class="ttdoc">Destroy the view. </div><div class="ttdef"><b>Definition:</b> View.cpp:24</div></div> <div class="ttc" id="classhws_1_1_view_html"><div class="ttname"><a href="classhws_1_1_view.html">hws::View</a></div><div class="ttdoc">Represents a single depot path to relative path. </div><div class="ttdef"><b>Definition:</b> View.h:16</div></div> <div class="ttc" id="classhws_1_1_view_html_a4faf8637d0dcaf28d52154880a28d1b0"><div class="ttname"><a href="classhws_1_1_view.html#a4faf8637d0dcaf28d52154880a28d1b0">hws::View::setViewPath</a></div><div class="ttdeci">virtual void setViewPath(const QString &path)</div><div class="ttdef"><b>Definition:</b> View.h:53</div></div> <div class="ttc" id="classhws_1_1_view_html_a5ad522327992e82c7608d98873e40d98"><div class="ttname"><a href="classhws_1_1_view.html#a5ad522327992e82c7608d98873e40d98">hws::View::setDepotPath</a></div><div class="ttdeci">virtual void setDepotPath(const QString &path)</div><div class="ttdoc">Change the 'absolute' depot path specification. </div><div class="ttdef"><b>Definition:</b> View.h:39</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. |