<!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/Branch.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">Branch.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_BRANCH_H__</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define __HWS_BRANCH_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 <QList></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> </div> <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "View.h"</span></div> <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div> <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="keyword">namespace </span><a class="code" href="namespacehws.html">hws</a></div> <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> {</div> <div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="classhws_1_1_branch.html"> 16</a></span>  <span class="keyword">class </span><a class="code" href="classhws_1_1_branch.html">Branch</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="l00020"></a><span class="lineno"> 20</span>  <a class="code" href="classhws_1_1_branch.html#aa7a621f9711870b3b1af0dcfb4e1e7f6">Branch</a>();</div> <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div> <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <a class="code" href="classhws_1_1_branch.html#aa7a621f9711870b3b1af0dcfb4e1e7f6">Branch</a>(<span class="keyword">const</span> <a class="code" href="classhws_1_1_branch.html">Branch</a> & b);</div> <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div> <div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <span class="keyword">virtual</span> <a class="code" href="classhws_1_1_branch.html#a4ca15337423da4a40646e88923f98c25">~Branch</a>();</div> <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div> <div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classhws_1_1_branch.html#a330f06852795b4b703f1fccf9c10a580"> 29</a></span>  <span class="keyword">const</span> QString & <a class="code" href="classhws_1_1_branch.html#a330f06852795b4b703f1fccf9c10a580">id</a>()<span class="keyword"> const</span></div> <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword"> </span>{</div> <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordflow">return</span> mId;</div> <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  }</div> <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div> <div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classhws_1_1_branch.html#a462d9eb48331b229f24b0873907e02d0"> 35</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classhws_1_1_branch.html#a462d9eb48331b229f24b0873907e02d0">setId</a>(<span class="keyword">const</span> QString & <span class="keywordtype">id</span>)</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>  mId = <a class="code" href="classhws_1_1_branch.html#a330f06852795b4b703f1fccf9c10a580">id</a>;</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> </div> <div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classhws_1_1_branch.html#a6f3dd5d72f404f2d65555236055ad600"> 41</a></span>  <span class="keyword">const</span> QString & <a class="code" href="classhws_1_1_branch.html#a6f3dd5d72f404f2d65555236055ad600">name</a>()<span class="keyword"> const</span></div> <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword"> </span>{</div> <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">return</span> mName;</div> <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  }</div> <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div> <div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classhws_1_1_branch.html#af52bc3b56416a70473870b75b01c7ed1"> 47</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classhws_1_1_branch.html#af52bc3b56416a70473870b75b01c7ed1">setName</a>(<span class="keyword">const</span> QString & <a class="code" href="classhws_1_1_branch.html#a6f3dd5d72f404f2d65555236055ad600">name</a>)</div> <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  {</div> <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  mName = <a class="code" href="classhws_1_1_branch.html#a6f3dd5d72f404f2d65555236055ad600">name</a>;</div> <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  }</div> <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div> <div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classhws_1_1_branch.html#a8df3599081ce004bed178f0076d7f45f"> 54</a></span>  <span class="keyword">const</span> QList<ViewPtr> & <a class="code" href="classhws_1_1_branch.html#a8df3599081ce004bed178f0076d7f45f">view</a>()<span class="keyword"> const</span></div> <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="keyword"> </span>{</div> <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordflow">return</span> mView;</div> <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  }</div> <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div> <div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classhws_1_1_branch.html#ab435ce047cd9a908984e31eebf6c302e"> 60</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classhws_1_1_branch.html#ab435ce047cd9a908984e31eebf6c302e">clearView</a>()</div> <div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  {</div> <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  mView.clear();</div> <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  }</div> <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div> <div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="classhws_1_1_branch.html#a201adaa5fac02321df10038b07bf4116"> 66</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classhws_1_1_branch.html#a201adaa5fac02321df10038b07bf4116">addView</a>(<span class="keyword">const</span> ViewPtr & v)</div> <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  {</div> <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  mView.append(v);</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="l00073"></a><span class="lineno"><a class="line" href="classhws_1_1_branch.html#adcdcf722f6566e9c1c4a9515bd5008d3"> 73</a></span>  <span class="keyword">const</span> QString & <a class="code" href="classhws_1_1_branch.html#adcdcf722f6566e9c1c4a9515bd5008d3">stream</a>()<span class="keyword"> const</span></div> <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="keyword"> </span>{</div> <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">return</span> mStream;</div> <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  }</div> <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div> <div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="classhws_1_1_branch.html#a2c1a3c98683496e3488de45ceb5a7509"> 80</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classhws_1_1_branch.html#a2c1a3c98683496e3488de45ceb5a7509">setStream</a>(<span class="keyword">const</span> QString & <a class="code" href="classhws_1_1_branch.html#adcdcf722f6566e9c1c4a9515bd5008d3">stream</a>)</div> <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  {</div> <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  mStream = <a class="code" href="classhws_1_1_branch.html#adcdcf722f6566e9c1c4a9515bd5008d3">stream</a>;</div> <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  }</div> <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div> <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keyword">const</span> <a class="code" href="classhws_1_1_branch.html">Branch</a>& <a class="code" href="classhws_1_1_branch.html#a80a13fc1cd5beeb4f275bb17516974b5">operator=</a>(<span class="keyword">const</span> <a class="code" href="classhws_1_1_branch.html">Branch</a>& b);</div> <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div> <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">protected</span>:</div> <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  QString mId;</div> <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  QString mName;</div> <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  QList<ViewPtr> mView;</div> <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  QString mStream;</div> <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  };</div> <div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div> <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">typedef</span> QSharedPointer<Branch> BranchPtr;</div> <div class="line"><a name="l00098"></a><span class="lineno"> 98</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="preprocessor">#endif </span><span class="comment">/* __HWS_BRANCH_H__ */</span><span class="preprocessor"></span></div> <div class="ttc" id="classhws_1_1_branch_html_a462d9eb48331b229f24b0873907e02d0"><div class="ttname"><a href="classhws_1_1_branch.html#a462d9eb48331b229f24b0873907e02d0">hws::Branch::setId</a></div><div class="ttdeci">virtual void setId(const QString &id)</div><div class="ttdoc">The ID of the branch may be used by products such as Git Fusion. </div><div class="ttdef"><b>Definition:</b> Branch.h:35</div></div> <div class="ttc" id="classhws_1_1_branch_html_a80a13fc1cd5beeb4f275bb17516974b5"><div class="ttname"><a href="classhws_1_1_branch.html#a80a13fc1cd5beeb4f275bb17516974b5">hws::Branch::operator=</a></div><div class="ttdeci">const Branch & operator=(const Branch &b)</div><div class="ttdoc">Copy the branch configuration. </div><div class="ttdef"><b>Definition:</b> Branch.cpp:25</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_branch_html_a4ca15337423da4a40646e88923f98c25"><div class="ttname"><a href="classhws_1_1_branch.html#a4ca15337423da4a40646e88923f98c25">hws::Branch::~Branch</a></div><div class="ttdeci">virtual ~Branch()</div><div class="ttdoc">Destroy the branch object. </div><div class="ttdef"><b>Definition:</b> Branch.cpp:21</div></div> <div class="ttc" id="classhws_1_1_branch_html"><div class="ttname"><a href="classhws_1_1_branch.html">hws::Branch</a></div><div class="ttdoc">The model of branches in basic Projects. </div><div class="ttdef"><b>Definition:</b> Branch.h:16</div></div> <div class="ttc" id="classhws_1_1_branch_html_af52bc3b56416a70473870b75b01c7ed1"><div class="ttname"><a href="classhws_1_1_branch.html#af52bc3b56416a70473870b75b01c7ed1">hws::Branch::setName</a></div><div class="ttdeci">virtual void setName(const QString &name)</div><div class="ttdoc">The name of the branch may be used for display purposes. </div><div class="ttdef"><b>Definition:</b> Branch.h:47</div></div> <div class="ttc" id="classhws_1_1_branch_html_a6f3dd5d72f404f2d65555236055ad600"><div class="ttname"><a href="classhws_1_1_branch.html#a6f3dd5d72f404f2d65555236055ad600">hws::Branch::name</a></div><div class="ttdeci">const QString & name() const </div><div class="ttdoc">The name of the branch may be used for display purposes. </div><div class="ttdef"><b>Definition:</b> Branch.h:41</div></div> <div class="ttc" id="classhws_1_1_branch_html_adcdcf722f6566e9c1c4a9515bd5008d3"><div class="ttname"><a href="classhws_1_1_branch.html#adcdcf722f6566e9c1c4a9515bd5008d3">hws::Branch::stream</a></div><div class="ttdeci">const QString & stream() const </div><div class="ttdef"><b>Definition:</b> Branch.h:73</div></div> <div class="ttc" id="classhws_1_1_branch_html_a8df3599081ce004bed178f0076d7f45f"><div class="ttname"><a href="classhws_1_1_branch.html#a8df3599081ce004bed178f0076d7f45f">hws::Branch::view</a></div><div class="ttdeci">const QList< ViewPtr > & view() const </div><div class="ttdef"><b>Definition:</b> Branch.h:54</div></div> <div class="ttc" id="classhws_1_1_branch_html_a330f06852795b4b703f1fccf9c10a580"><div class="ttname"><a href="classhws_1_1_branch.html#a330f06852795b4b703f1fccf9c10a580">hws::Branch::id</a></div><div class="ttdeci">const QString & id() const </div><div class="ttdoc">The ID of the branch may be used by products such as Git Fusion. </div><div class="ttdef"><b>Definition:</b> Branch.h:29</div></div> <div class="ttc" id="classhws_1_1_branch_html_ab435ce047cd9a908984e31eebf6c302e"><div class="ttname"><a href="classhws_1_1_branch.html#ab435ce047cd9a908984e31eebf6c302e">hws::Branch::clearView</a></div><div class="ttdeci">virtual void clearView()</div><div class="ttdoc">Clear the existing view. </div><div class="ttdef"><b>Definition:</b> Branch.h:60</div></div> <div class="ttc" id="classhws_1_1_branch_html_a2c1a3c98683496e3488de45ceb5a7509"><div class="ttname"><a href="classhws_1_1_branch.html#a2c1a3c98683496e3488de45ceb5a7509">hws::Branch::setStream</a></div><div class="ttdeci">virtual void setStream(const QString &stream)</div><div class="ttdef"><b>Definition:</b> Branch.h:80</div></div> <div class="ttc" id="classhws_1_1_branch_html_aa7a621f9711870b3b1af0dcfb4e1e7f6"><div class="ttname"><a href="classhws_1_1_branch.html#aa7a621f9711870b3b1af0dcfb4e1e7f6">hws::Branch::Branch</a></div><div class="ttdeci">Branch()</div><div class="ttdoc">Construct an empty Branch. </div><div class="ttdef"><b>Definition:</b> Branch.cpp:5</div></div> <div class="ttc" id="classhws_1_1_branch_html_a201adaa5fac02321df10038b07bf4116"><div class="ttname"><a href="classhws_1_1_branch.html#a201adaa5fac02321df10038b07bf4116">hws::Branch::addView</a></div><div class="ttdeci">virtual void addView(const ViewPtr &v)</div><div class="ttdoc">Add a view to the branch, which adds a single mapping. </div><div class="ttdef"><b>Definition:</b> Branch.h:66</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. |