<!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 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_view.html">View</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_view-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">hws::View Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>Represents a single depot path to relative path. <a href="classhws_1_1_view.html#details">More...</a></p> <p><code>#include <<a class="el" href="_view_8h_source.html">View.h</a>></code></p> <div class="dynheader"> Inheritance diagram for hws::View:</div> <div class="dyncontent"> <div class="center"> <img src="classhws_1_1_view.png" usemap="#hws::View_map" alt=""/> <map id="hws::View_map" name="hws::View_map"> <area href="classhws_1_1_project_1_1_view_node.html" alt="hws::Project::ViewNode" shape="rect" coords="0,56,144,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:a5df3d3c9a8c8f1bed92cede5f633b4fa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5df3d3c9a8c8f1bed92cede5f633b4fa"></a>  </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_view.html#a5df3d3c9a8c8f1bed92cede5f633b4fa">View</a> ()</td></tr> <tr class="memdesc:a5df3d3c9a8c8f1bed92cede5f633b4fa"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new view with empty paths. <br /></td></tr> <tr class="separator:a5df3d3c9a8c8f1bed92cede5f633b4fa"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7d90b4f072123776c7e50aa62bdc1af8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7d90b4f072123776c7e50aa62bdc1af8"></a>  </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_view.html#a7d90b4f072123776c7e50aa62bdc1af8">View</a> (const QString &<a class="el" href="classhws_1_1_view.html#a23b972f01c920639a1cd1f75f327b9f7">depotPath</a>, const QString &<a class="el" href="classhws_1_1_view.html#a0edfaa1e3d8a350c10ad84b06a1b2306">viewPath</a>)</td></tr> <tr class="memdesc:a7d90b4f072123776c7e50aa62bdc1af8"><td class="mdescLeft"> </td><td class="mdescRight">Construct the view with both paths defined. <br /></td></tr> <tr class="separator:a7d90b4f072123776c7e50aa62bdc1af8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2033c6894e5aa35e5915dd1141b0d323"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2033c6894e5aa35e5915dd1141b0d323"></a>  </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_view.html#a2033c6894e5aa35e5915dd1141b0d323">View</a> (const <a class="el" href="classhws_1_1_view.html">View</a> &v)</td></tr> <tr class="memdesc:a2033c6894e5aa35e5915dd1141b0d323"><td class="mdescLeft"> </td><td class="mdescRight">Copy the paths from an existing view object. <br /></td></tr> <tr class="separator:a2033c6894e5aa35e5915dd1141b0d323"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acbc77fc6c3f2ae55d38b0f6f7e37e44e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acbc77fc6c3f2ae55d38b0f6f7e37e44e"></a> virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_view.html#acbc77fc6c3f2ae55d38b0f6f7e37e44e">~View</a> ()</td></tr> <tr class="memdesc:acbc77fc6c3f2ae55d38b0f6f7e37e44e"><td class="mdescLeft"> </td><td class="mdescRight">Destroy the view. <br /></td></tr> <tr class="separator:acbc77fc6c3f2ae55d38b0f6f7e37e44e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a23b972f01c920639a1cd1f75f327b9f7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a23b972f01c920639a1cd1f75f327b9f7"></a> const QString & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_view.html#a23b972f01c920639a1cd1f75f327b9f7">depotPath</a> () const </td></tr> <tr class="memdesc:a23b972f01c920639a1cd1f75f327b9f7"><td class="mdescLeft"> </td><td class="mdescRight">The 'absolute' depot path file specification. <br /></td></tr> <tr class="separator:a23b972f01c920639a1cd1f75f327b9f7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5ad522327992e82c7608d98873e40d98"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5ad522327992e82c7608d98873e40d98"></a> virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_view.html#a5ad522327992e82c7608d98873e40d98">setDepotPath</a> (const QString &path)</td></tr> <tr class="memdesc:a5ad522327992e82c7608d98873e40d98"><td class="mdescLeft"> </td><td class="mdescRight">Change the 'absolute' depot path specification. <br /></td></tr> <tr class="separator:a5ad522327992e82c7608d98873e40d98"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0edfaa1e3d8a350c10ad84b06a1b2306"><td class="memItemLeft" align="right" valign="top">const QString & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_view.html#a0edfaa1e3d8a350c10ad84b06a1b2306">viewPath</a> () const </td></tr> <tr class="separator:a0edfaa1e3d8a350c10ad84b06a1b2306"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4faf8637d0dcaf28d52154880a28d1b0"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_view.html#a4faf8637d0dcaf28d52154880a28d1b0">setViewPath</a> (const QString &path)</td></tr> <tr class="separator:a4faf8637d0dcaf28d52154880a28d1b0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0ffa1d5ef2449d1142fcd92894d52658"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0ffa1d5ef2449d1142fcd92894d52658"></a> <a class="el" href="classhws_1_1_view.html">View</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhws_1_1_view.html#a0ffa1d5ef2449d1142fcd92894d52658">operator=</a> (const <a class="el" href="classhws_1_1_view.html">View</a> &v)</td></tr> <tr class="memdesc:a0ffa1d5ef2449d1142fcd92894d52658"><td class="mdescLeft"> </td><td class="mdescRight">Copy all values from another <a class="el" href="classhws_1_1_view.html" title="Represents a single depot path to relative path. ">View</a>. <br /></td></tr> <tr class="separator:a0ffa1d5ef2449d1142fcd92894d52658"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Represents a single depot path to relative path. </p> <p>Represents a generic mapping used by branches and client views. This representation is very focused on the needs of our project model, which is similar to how Git Fusion represents branches. That is, the "relative path" is used instead of an absolute "client" path. This also only represents one mapping. </p> </div><h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a4faf8637d0dcaf28d52154880a28d1b0"></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::View::setViewPath </td> <td>(</td> <td class="paramtype">const QString & </td> <td class="paramname"><em>path</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>A relative path specifciation that could be appended to a client prefix, e.g., <code>"//my_client" + view.viewPath()</code> </p> <p>Reimplemented in <a class="el" href="classhws_1_1_project_1_1_view_node.html#a6cfb73f67b40f091e852399e33b41c46">hws::Project::ViewNode</a>.</p> </div> </div> <a class="anchor" id="a0edfaa1e3d8a350c10ad84b06a1b2306"></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::View::viewPath </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>A relative path specifciation that could be appended to a client prefix, e.g., <code>"//my_client" + view.viewPath()</code> </p> </div> </div> <hr/>The documentation for this class was generated from the following files:<ul> <li>hws/<a class="el" href="_view_8h_source.html">View.h</a></li> <li>hws/View.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. |