<!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 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> <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 class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><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="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</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"><b>hws</b></li><li class="navelem"><a class="el" href="classhws_1_1_branch.html">Branch</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="classhws_1_1_branch-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">hws::Branch Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>The model of branches in basic Projects. <a href="classhws_1_1_branch.html#details">More...</a></p> <p><code>#include <<a class="el" href="_branch_8h_source.html">Branch.h</a>></code></p> <div class="dynheader"> Inheritance diagram for hws::Branch:</div> <div class="dyncontent"> <div class="center"> <img src="classhws_1_1_branch.png" usemap="#hws::Branch_map" alt=""/> <map id="hws::Branch_map" name="hws::Branch_map"> <area href="classhws_1_1_project_1_1_branch_node.html" alt="hws::Project::BranchNode" shape="rect" coords="0,56,157,80"/> </map> </div></div> <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:aa7a621f9711870b3b1af0dcfb4e1e7f6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa7a621f9711870b3b1af0dcfb4e1e7f6"></a>  </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_branch.html#aa7a621f9711870b3b1af0dcfb4e1e7f6">Branch</a> ()</td></tr> <tr class="memdesc:aa7a621f9711870b3b1af0dcfb4e1e7f6"><td class="mdescLeft"> </td><td class="mdescRight">Construct an empty <a class="el" href="classhws_1_1_branch.html" title="The model of branches in basic Projects. ">Branch</a>. <br /></td></tr> <tr class="separator:aa7a621f9711870b3b1af0dcfb4e1e7f6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ae357b68ac68c435ab7a996a072262c1e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae357b68ac68c435ab7a996a072262c1e"></a>  </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_branch.html#ae357b68ac68c435ab7a996a072262c1e">Branch</a> (const <a class="el" href="classhws_1_1_branch.html">Branch</a> &b)</td></tr> <tr class="memdesc:ae357b68ac68c435ab7a996a072262c1e"><td class="mdescLeft"> </td><td class="mdescRight">Copy an existing branch. <br /></td></tr> <tr class="separator:ae357b68ac68c435ab7a996a072262c1e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4ca15337423da4a40646e88923f98c25"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4ca15337423da4a40646e88923f98c25"></a> virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_branch.html#a4ca15337423da4a40646e88923f98c25">~Branch</a> ()</td></tr> <tr class="memdesc:a4ca15337423da4a40646e88923f98c25"><td class="mdescLeft"> </td><td class="mdescRight">Destroy the branch object. <br /></td></tr> <tr class="separator:a4ca15337423da4a40646e88923f98c25"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a330f06852795b4b703f1fccf9c10a580"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a330f06852795b4b703f1fccf9c10a580"></a> const QString & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_branch.html#a330f06852795b4b703f1fccf9c10a580">id</a> () const </td></tr> <tr class="memdesc:a330f06852795b4b703f1fccf9c10a580"><td class="mdescLeft"> </td><td class="mdescRight">The ID of the branch may be used by products such as Git Fusion. <br /></td></tr> <tr class="separator:a330f06852795b4b703f1fccf9c10a580"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a462d9eb48331b229f24b0873907e02d0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a462d9eb48331b229f24b0873907e02d0"></a> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_branch.html#a462d9eb48331b229f24b0873907e02d0">setId</a> (const QString &<a class="el" href="classhws_1_1_branch.html#a330f06852795b4b703f1fccf9c10a580">id</a>)</td></tr> <tr class="memdesc:a462d9eb48331b229f24b0873907e02d0"><td class="mdescLeft"> </td><td class="mdescRight">The ID of the branch may be used by products such as Git Fusion. <br /></td></tr> <tr class="separator:a462d9eb48331b229f24b0873907e02d0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6f3dd5d72f404f2d65555236055ad600"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6f3dd5d72f404f2d65555236055ad600"></a> const QString & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_branch.html#a6f3dd5d72f404f2d65555236055ad600">name</a> () const </td></tr> <tr class="memdesc:a6f3dd5d72f404f2d65555236055ad600"><td class="mdescLeft"> </td><td class="mdescRight">The name of the branch may be used for display purposes. <br /></td></tr> <tr class="separator:a6f3dd5d72f404f2d65555236055ad600"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af52bc3b56416a70473870b75b01c7ed1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af52bc3b56416a70473870b75b01c7ed1"></a> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_branch.html#af52bc3b56416a70473870b75b01c7ed1">setName</a> (const QString &<a class="el" href="classhws_1_1_branch.html#a6f3dd5d72f404f2d65555236055ad600">name</a>)</td></tr> <tr class="memdesc:af52bc3b56416a70473870b75b01c7ed1"><td class="mdescLeft"> </td><td class="mdescRight">The name of the branch may be used for display purposes. <br /></td></tr> <tr class="separator:af52bc3b56416a70473870b75b01c7ed1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8df3599081ce004bed178f0076d7f45f"><td class="memItemLeft" align="right" valign="top">const QList< ViewPtr > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_branch.html#a8df3599081ce004bed178f0076d7f45f">view</a> () const </td></tr> <tr class="separator:a8df3599081ce004bed178f0076d7f45f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab435ce047cd9a908984e31eebf6c302e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab435ce047cd9a908984e31eebf6c302e"></a> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_branch.html#ab435ce047cd9a908984e31eebf6c302e">clearView</a> ()</td></tr> <tr class="memdesc:ab435ce047cd9a908984e31eebf6c302e"><td class="mdescLeft"> </td><td class="mdescRight">Clear the existing view. <br /></td></tr> <tr class="separator:ab435ce047cd9a908984e31eebf6c302e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a201adaa5fac02321df10038b07bf4116"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a201adaa5fac02321df10038b07bf4116"></a> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_branch.html#a201adaa5fac02321df10038b07bf4116">addView</a> (const ViewPtr &v)</td></tr> <tr class="memdesc:a201adaa5fac02321df10038b07bf4116"><td class="mdescLeft"> </td><td class="mdescRight">Add a view to the branch, which adds a single mapping. <br /></td></tr> <tr class="separator:a201adaa5fac02321df10038b07bf4116"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:adcdcf722f6566e9c1c4a9515bd5008d3"><td class="memItemLeft" align="right" valign="top">const QString & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_branch.html#adcdcf722f6566e9c1c4a9515bd5008d3">stream</a> () const </td></tr> <tr class="separator:adcdcf722f6566e9c1c4a9515bd5008d3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2c1a3c98683496e3488de45ceb5a7509"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_branch.html#a2c1a3c98683496e3488de45ceb5a7509">setStream</a> (const QString &<a class="el" href="classhws_1_1_branch.html#adcdcf722f6566e9c1c4a9515bd5008d3">stream</a>)</td></tr> <tr class="separator:a2c1a3c98683496e3488de45ceb5a7509"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a80a13fc1cd5beeb4f275bb17516974b5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a80a13fc1cd5beeb4f275bb17516974b5"></a> const <a class="el" href="classhws_1_1_branch.html">Branch</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_branch.html#a80a13fc1cd5beeb4f275bb17516974b5">operator=</a> (const <a class="el" href="classhws_1_1_branch.html">Branch</a> &b)</td></tr> <tr class="memdesc:a80a13fc1cd5beeb4f275bb17516974b5"><td class="mdescLeft"> </td><td class="mdescRight">Copy the branch configuration. <br /></td></tr> <tr class="separator:a80a13fc1cd5beeb4f275bb17516974b5"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> Protected Attributes</h2></td></tr> <tr><td colspan="2"><div class="groupHeader"></div></td></tr> <tr class="memitem:a2f6c55d8f02ba7550ea80cddeab95ccb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2f6c55d8f02ba7550ea80cddeab95ccb"></a> QString </td><td class="memItemRight" valign="bottom"><b>mId</b></td></tr> <tr class="separator:a2f6c55d8f02ba7550ea80cddeab95ccb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a58f032220e80b855437096e6ef88db92"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a58f032220e80b855437096e6ef88db92"></a> QString </td><td class="memItemRight" valign="bottom"><b>mName</b></td></tr> <tr class="separator:a58f032220e80b855437096e6ef88db92"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3ca157374a081fa1bcc5a958ed07d4af"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ca157374a081fa1bcc5a958ed07d4af"></a> QList< ViewPtr > </td><td class="memItemRight" valign="bottom"><b>mView</b></td></tr> <tr class="separator:a3ca157374a081fa1bcc5a958ed07d4af"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abeae4eaf01642c820ff4ebf7e119034e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abeae4eaf01642c820ff4ebf7e119034e"></a> QString </td><td class="memItemRight" valign="bottom"><b>mStream</b></td></tr> <tr class="separator:abeae4eaf01642c820ff4ebf7e119034e"><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 model of branches in basic Projects. </p> <p>A project contains one or more branches. For Helix Sync projects, there is only one branch. </p> </div><h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a2c1a3c98683496e3488de45ceb5a7509"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void hws::Branch::setStream </td> <td>(</td> <td class="paramtype">const QString & </td> <td class="paramname"><em>stream</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Set the stream reference for the branch. Only the view or the stream should be set. Not both. </p> <p>Reimplemented in <a class="el" href="classhws_1_1_project_1_1_branch_node.html#a2c0dc73329805e99cda6e08162e5a164">hws::Project::BranchNode</a>.</p> </div> </div> <a class="anchor" id="adcdcf722f6566e9c1c4a9515bd5008d3"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const QString& hws::Branch::stream </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Set the stream reference for the branch. Only the view or the stream should be set. Not both. </p> </div> </div> <a class="anchor" id="a8df3599081ce004bed178f0076d7f45f"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const QList<ViewPtr>& hws::Branch::view </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>If the branch is composed of links to existing content, the view will not be empty. </p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li>hws/<a class="el" href="_branch_8h_source.html">Branch.h</a></li> <li>hws/Branch.cpp</li> </ul> </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. |