Skip to content

Commit

Permalink
add main page
Browse files Browse the repository at this point in the history
  • Loading branch information
pit-ray committed Feb 12, 2024
1 parent b3092c8 commit 9367647
Show file tree
Hide file tree
Showing 25 changed files with 481 additions and 49 deletions.
4 changes: 2 additions & 2 deletions Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -949,7 +949,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.

INPUT = "include/fluent_tray.hpp"
INPUT = "./README.md" "./include/fluent_tray.hpp"

# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
Expand Down Expand Up @@ -1165,7 +1165,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.

USE_MDFILE_AS_MAINPAGE =
USE_MDFILE_AS_MAINPAGE = "./README.md"

# The Fortran standard specifies that for fixed formatted Fortran code all
# characters from position 72 are to be considered as comment. A common
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<h1 align="center">fluent-tray</h1>
<p align="center"><img src="./assets/banner.png" width=128/></p>
<p align="center"><h1>fluent-tray</h1></p>
<p align="center"><img src="https://github.com/pit-ray/fluent-tray/blob/main/assets/banner.png?raw=true" width=128/></p>
<p align="center"><b>Fluent Design-based GUI Library for System Tray Applications</b></p>
<p align="center"><b>:fire:Warning: This project is still under development. Do not use it in a production environment.:fire:</b></p>

Expand All @@ -20,7 +20,7 @@ Currently, only Windows is supported.

## Demo

<img src="assets/demo.png" />
<img src="https://github.com/pit-ray/fluent-tray/blob/main/assets/demo.png?raw=true" />

#### Code
Simply create a `FluentTray` object and add a menu with `.add_menu()`.
Expand Down
86 changes: 86 additions & 0 deletions docs/_r_e_a_d_m_e_8md.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>fluent-tray: README.md File Reference</title>
<link rel="icon" href="icon.png" type="image/x-icon" />
<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>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.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>
<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 id="projectrow">
<td id="projectlogo"><img alt="Logo" src="doxygen_icon.png"/></td>
<td id="projectalign">
<div id="projectname">fluent-tray
</div>
<div id="projectbrief">Fluent Design-based GUI Library for System Tray Applications</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">README.md File Reference</div></div>
</div><!--header-->
<div class="contents">
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
</small></address>
</body>
</html>
1 change: 1 addition & 0 deletions docs/doxygen_crawl.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
<body>
<a href="fluent__tray_8hpp_source.html"/>
<a href="fluent__tray_8hpp.html"/>
<a href="_r_e_a_d_m_e_8md.html"/>
<a href="namespacefluent__tray.html"/>
<a href="classfluent__tray_1_1_fluent_menu.html"/>
<a href="classfluent__tray_1_1_fluent_menu-members.html"/>
Expand Down
77 changes: 74 additions & 3 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>fluent-tray: Main Page</title>
<title>fluent-tray: fluent-tray</title>
<link rel="icon" href="icon.png" type="image/x-icon" />
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
Expand Down Expand Up @@ -73,10 +73,81 @@
</div>
</div>

<div class="header">
<div class="headertitle"><div class="title">fluent-tray Documentation</div></div>
<div><div class="header">
<div class="headertitle"><div class="title">fluent-tray </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p align="center"><a class="anchor" id="md__r_e_a_d_m_e"></a> </p>
<h1>fluent-tray</h1>
<p align="center"></p>
<p><img src="https://github.com/pit-ray/fluent-tray/blob/main/assets/banner.png?raw=true" alt="" width="128/" class="inline"/></p>
<p align="center"></p>
<p><b>Fluent Design-based GUI Library for System Tray Applications</b></p>
<p align="center"></p>
<p><b>:fire:Warning: This project is still under development. Do not use it in a production environment.:fire:</b></p>
<p align="center"></p>
<p><a href="https://scan.coverity.com/projects/pit-ray-fluent-tray"><img src="https://img.shields.io/coverity/scan/pit-ray-fluent-tray?style=flat-square" alt="Coverity Scan Build Status" class="inline"/></a> <a href="https://www.codacy.com/gh/pit-ray/fluent-tray/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=pit-ray/fluent-tray&amp;utm_campaign=Badge_Grade"><img src="https://img.shields.io/codacy/grade/8f2e6f2826904efd82019f5888574327?style=flat-square" alt="" class="inline"/></a> <a href="https://github.com/pit-ray/fluent-tray/actions/workflows/codeql.yml"><img src="https://img.shields.io/github/actions/workflow/status/pit-ray/fluent-tray/codeql.yml?branch=main&amp;label=CodeQL&amp;logo=github&amp;style=flat-square" alt="" class="inline"/></a> <br />
<br />
<a href="https://github.com/pit-ray/fluent-tray/actions/workflows/coverity.yml"><img src="https://img.shields.io/github/actions/workflow/status/pit-ray/fluent-tray/coverity.yml?branch=main&amp;label=cov-build&amp;logo=github&amp;style=flat-square" alt="" class="inline"/></a> <a href="https://github.com/pit-ray/fluent-tray/actions/workflows/msvc.yml"><img src="https://img.shields.io/github/actions/workflow/status/pit-ray/fluent-tray/windows.yml?branch=main&amp;label=Windows&amp;logo=github&amp;style=flat-square" alt="" class="inline"/></a> </p>
<h2><a class="anchor" id="autotoc_md0"></a>
Concept</h2>
<p>fluent-tray provides a simple system tray icon and menu to easily create resident applications that do not require complex windows. Since only the native API is used, all you have to do is include a single header file.</p>
<p>Currently, only Windows is supported.</p>
<h2><a class="anchor" id="autotoc_md1"></a>
Demo</h2>
<p><img src="https://github.com/pit-ray/fluent-tray/blob/main/assets/demo.png?raw=true" alt="" class="inline"/></p>
<h4><a class="anchor" id="autotoc_md2"></a>
Code</h4>
<p>Simply create a <code>FluentTray</code> object and add a menu with <code>.add_menu()</code>.</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="fluent__tray_8hpp.html">fluent_tray.hpp</a>&quot;</span></div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">int</span> main()</div>
<div class="line">{</div>
<div class="line"> <span class="keyword">using namespace </span><a class="code hl_namespace" href="namespacefluent__tray.html">fluent_tray</a> ;</div>
<div class="line"> </div>
<div class="line"> <a class="code hl_class" href="classfluent__tray_1_1_fluent_tray.html">FluentTray</a> tray{} ;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Initialize the tray icon.</span></div>
<div class="line"> tray.<a class="code hl_function" href="classfluent__tray_1_1_fluent_tray.html#a317e0bfab8dea66def0cb307541e76f6">create_tray</a>(<span class="stringliteral">&quot;demo&quot;</span>, <span class="stringliteral">&quot;demo/assets/icon.ico&quot;</span>) ;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Add menus in order from the top.</span></div>
<div class="line"> tray.add_menu(<span class="stringliteral">&quot;Home&quot;</span>, <span class="stringliteral">&quot;demo/assets/fa-home.ico&quot;</span>) ;</div>
<div class="line"> tray.add_separator() ;</div>
<div class="line"> </div>
<div class="line"> tray.add_menu(<span class="stringliteral">&quot;Download&quot;</span>, <span class="stringliteral">&quot;demo/assets/fa-download.ico&quot;</span>) ;</div>
<div class="line"> tray.add_menu(<span class="stringliteral">&quot;Insight&quot;</span>, <span class="stringliteral">&quot;demo/assets/fa-line-chart.ico&quot;</span>) ;</div>
<div class="line"> tray.add_separator() ;</div>
<div class="line"> </div>
<div class="line"> tray.add_menu(<span class="stringliteral">&quot;Coffee&quot;</span>, <span class="stringliteral">&quot;demo/assets/fa-coffee.ico&quot;</span>, <span class="keyword">true</span>) ;</div>
<div class="line"> tray.add_menu(<span class="stringliteral">&quot;Desktop&quot;</span>, <span class="stringliteral">&quot;demo/assets/fa-desktop.ico&quot;</span>, <span class="keyword">true</span>) ;</div>
<div class="line"> tray.add_separator() ;</div>
<div class="line"> </div>
<div class="line"> tray.add_menu(<span class="stringliteral">&quot;Exit&quot;</span>, <span class="stringliteral">&quot;demo/assets/fa-sign-out.ico&quot;</span>) ;</div>
<div class="line"> </div>
<div class="line"> <span class="comment">// Start message loop</span></div>
<div class="line"> tray.update_with_loop() ;</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span> 0 ;</div>
<div class="line">}</div>
<div class="ttc" id="aclassfluent__tray_1_1_fluent_tray_html"><div class="ttname"><a href="classfluent__tray_1_1_fluent_tray.html">fluent_tray::FluentTray</a></div><div class="ttdoc">Class with information on the entire tray.</div><div class="ttdef"><b>Definition</b> fluent_tray.hpp:643</div></div>
<div class="ttc" id="aclassfluent__tray_1_1_fluent_tray_html_a317e0bfab8dea66def0cb307541e76f6"><div class="ttname"><a href="classfluent__tray_1_1_fluent_tray.html#a317e0bfab8dea66def0cb307541e76f6">fluent_tray::FluentTray::create_tray</a></div><div class="ttdeci">bool create_tray(const std::string &amp;app_name, const std::string &amp;icon_path=&quot;&quot;, LONG menu_x_margin=5, LONG menu_y_margin=5, LONG menu_x_pad=5, LONG menu_y_pad=5, BYTE opacity=255, bool round_corner=true)</div><div class="ttdoc">Initialize tray and create icon on tray.</div><div class="ttdef"><b>Definition</b> fluent_tray.hpp:728</div></div>
<div class="ttc" id="afluent__tray_8hpp_html"><div class="ttname"><a href="fluent__tray_8hpp.html">fluent_tray.hpp</a></div><div class="ttdoc">Fluent Design-based GUI Library for System Tray Applications.</div></div>
<div class="ttc" id="anamespacefluent__tray_html"><div class="ttname"><a href="namespacefluent__tray.html">fluent_tray</a></div><div class="ttdoc">Base namespace.</div></div>
</div><!-- fragment --><h4><a class="anchor" id="autotoc_md3"></a>
Build</h4>
<p>You can build this demo using <code>cmake</code> as follows.</p>
<div class="fragment"><div class="line">$ cmake -B build demo</div>
<div class="line">$ cmake --build build</div>
<div class="line">$ ./build/Debug/fluent-tray-demo.exe</div>
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md4"></a>
Test</h2>
<div class="fragment"><div class="line">$ cmake -B build_test test</div>
<div class="line">$ cmake --build build_test</div>
<div class="line">$ ctest -C Debug --test-dir build_test --output-on-failure</div>
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md5"></a>
License</h2>
<p>This library is provided by pit-ray under the <a href="./LICENSE.txt">MIT License</a>. </p>
</div></div><!-- PageDoc -->
<a href="doxygen_crawl.html"/>
</div><!-- contents -->
<!-- start footer part -->
Expand Down
Loading

0 comments on commit 9367647

Please sign in to comment.