LMU/musrfit
5
1
Fork 0
Code Issues 5 Pull Requests Actions Packages Projects Releases 6 Activity
Files
14cabbd87ef4efe2ed0bba54472eee90675a5cee
musrfit/musredit/html/classPGetTitleBlockDialog.html
T
Gitea Actions 14cabbd87e Deploy site
2026-07-31 18:47:29 +00:00

371 lines
22 KiB
HTML
Raw Blame History

<!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.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>musredit: PGetTitleBlockDialog 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.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="projectalign">
<div id="projectname">musredit<span id="projectnumber">&#160;1.0.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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 id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-slots">Private Slots</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classPGetTitleBlockDialog-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">PGetTitleBlockDialog Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Dialog for creating and editing TITLE blocks in msr files.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="PGetTitleBlockDialog_8h_source.html">PGetTitleBlockDialog.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for PGetTitleBlockDialog:</div>
<div class="dyncontent">
<div class="center"><img src="classPGetTitleBlockDialog__inherit__graph.png" border="0" usemap="#aPGetTitleBlockDialog_inherit__map" alt="Inheritance graph"/></div>
<map name="aPGetTitleBlockDialog_inherit__map" id="aPGetTitleBlockDialog_inherit__map">
<area shape="rect" title="Dialog for creating and editing TITLE blocks in msr files." alt="" coords="37,81,188,109"/>
<area shape="rect" title=" " alt="" coords="5,5,76,33"/>
<area shape="poly" title=" " alt="" coords="66,42,102,79,98,82,62,46"/>
<area shape="rect" title=" " alt="" coords="100,5,269,33"/>
<area shape="poly" title=" " alt="" coords="163,46,127,82,123,79,159,42"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for PGetTitleBlockDialog:</div>
<div class="dyncontent">
<div class="center"><img src="classPGetTitleBlockDialog__coll__graph.png" border="0" usemap="#aPGetTitleBlockDialog_coll__map" alt="Collaboration graph"/></div>
<map name="aPGetTitleBlockDialog_coll__map" id="aPGetTitleBlockDialog_coll__map">
<area shape="rect" title="Dialog for creating and editing TITLE blocks in msr files." alt="" coords="37,81,188,109"/>
<area shape="rect" title=" " alt="" coords="5,5,76,33"/>
<area shape="poly" title=" " alt="" coords="66,42,102,79,98,82,62,46"/>
<area shape="rect" title=" " alt="" coords="100,5,269,33"/>
<area shape="poly" title=" " alt="" coords="163,46,127,82,123,79,159,42"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a87bd554c0c033fb5685810e2ebadc097" id="r_a87bd554c0c033fb5685810e2ebadc097"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a87bd554c0c033fb5685810e2ebadc097">PGetTitleBlockDialog</a> (const QString helpUrl)</td></tr>
<tr class="memdesc:a87bd554c0c033fb5685810e2ebadc097"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a dialog for entering or editing a title. <br /></td></tr>
<tr class="separator:a87bd554c0c033fb5685810e2ebadc097"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62b8faf102416014ff1d2f97120ec32c" id="r_a62b8faf102416014ff1d2f97120ec32c"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a62b8faf102416014ff1d2f97120ec32c">~PGetTitleBlockDialog</a> ()</td></tr>
<tr class="memdesc:a62b8faf102416014ff1d2f97120ec32c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor. <br /></td></tr>
<tr class="separator:a62b8faf102416014ff1d2f97120ec32c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ff9e6ff81c3d2f00229da59f02302c9" id="r_a7ff9e6ff81c3d2f00229da59f02302c9"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7ff9e6ff81c3d2f00229da59f02302c9">getTitle</a> ()</td></tr>
<tr class="memdesc:a7ff9e6ff81c3d2f00229da59f02302c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the entered title text. <br /></td></tr>
<tr class="separator:a7ff9e6ff81c3d2f00229da59f02302c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-slots" name="pri-slots"></a>
Private Slots</h2></td></tr>
<tr class="memitem:add38657c93905eb599afd918845128a9" id="r_add38657c93905eb599afd918845128a9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#add38657c93905eb599afd918845128a9">helpContent</a> ()</td></tr>
<tr class="memdesc:add38657c93905eb599afd918845128a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Opens the online help for TITLE blocks. <br /></td></tr>
<tr class="separator:add38657c93905eb599afd918845128a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a73edf25f9be2907251a5152f1f873633" id="r_a73edf25f9be2907251a5152f1f873633"><td class="memItemLeft" align="right" valign="top">QString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a73edf25f9be2907251a5152f1f873633">fHelpUrl</a></td></tr>
<tr class="memdesc:a73edf25f9be2907251a5152f1f873633"><td class="mdescLeft">&#160;</td><td class="mdescRight">URL to the online documentation for TITLE blocks. <br /></td></tr>
<tr class="separator:a73edf25f9be2907251a5152f1f873633"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Dialog for creating and editing TITLE blocks in msr files. </p>
<p>This dialog provides a simple text input interface for entering or modifying the title of a musrfit msr file. The title serves as a descriptive label for the analysis and appears at the beginning of the msr file.</p>
<dl class="section user"><dt>TITLE Block Format:</dt><dd>The TITLE block consists of a single line in the msr file: <div class="fragment"><div class="line">sample_name or_measurement_description</div>
</div><!-- fragment --></dd></dl>
<dl class="section user"><dt>Usage:</dt><dd>The dialog is accessed through the menu: Edit → Add Block → Title Block. It presents a single-line text input field where users can enter or edit the title text. The dialog is modal, requiring user interaction before returning to the main editor.</dd></dl>
<dl class="section user"><dt>Example Titles:</dt><dd><ul>
<li>"TF-ZF transition measurement on Cu sample at 10K"</li>
<li>"Longitudinal field scan H=0-2000G"</li>
<li>"Temperature dependence study 5-300K"</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The title is optional in msr files but recommended for documentation purposes. </dd>
<dd>
The title should be a single line without newline characters.</dd></dl>
<dl class="section see"><dt>See also</dt><dd>musredit Main editor application </dd></dl>
<p class="definition">Definition at line <a class="el" href="PGetTitleBlockDialog_8h_source.html#l00088">88</a> of file <a class="el" href="PGetTitleBlockDialog_8h_source.html">PGetTitleBlockDialog.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a87bd554c0c033fb5685810e2ebadc097" name="a87bd554c0c033fb5685810e2ebadc097"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a87bd554c0c033fb5685810e2ebadc097">&#9670;&#160;</a></span>PGetTitleBlockDialog()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PGetTitleBlockDialog::PGetTitleBlockDialog </td>
<td>(</td>
<td class="paramtype">const QString</td> <td class="paramname"><span class="paramname"><em>helpUrl</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a dialog for entering or editing a title. </p>
<p>Constructor - Initializes the TITLE block dialog.</p>
<p>Initializes the dialog with a text input field and help button. The dialog is configured as modal to ensure user interaction completion before returning to the main editor window.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">helpUrl</td><td>URL string pointing to online documentation for TITLE blocks. If empty, the help button will display a placeholder message.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#add38657c93905eb599afd918845128a9" title="Opens the online help for TITLE blocks.">helpContent()</a> For the help system implementation</dd></dl>
<p>Sets up the user interface for the title input dialog. The dialog contains a single QLineEdit widget for text entry and standard OK/Cancel buttons. The interface is loaded from the UI definition file and configured as a modal dialog.</p>
<p>The dialog is designed to be simple and focused, presenting only the essential controls needed to enter or edit a title string. No complex initialization or data loading is required beyond basic UI setup.</p>
<p>The modal configuration ensures that users complete the title entry or explicitly cancel before returning to the main editor, preventing incomplete or ambiguous states.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">helpUrl</td><td>URL string for the online help documentation. If empty, the help button will display a placeholder message instead of opening a web browser. The URL should point to documentation explaining the purpose and format of msr file titles.</td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>The dialog does not validate the title content. Validation, if needed, should be performed by the caller after retrieving the title via <a class="el" href="#a7ff9e6ff81c3d2f00229da59f02302c9" title="Returns the entered title text.">getTitle()</a>.</dd></dl>
<dl class="section see"><dt>See also</dt><dd>setupUi() Qt Designer generated UI initialization method </dd>
<dd>
setModal() Configures the dialog as modal </dd>
<dd>
<a class="el" href="#a7ff9e6ff81c3d2f00229da59f02302c9" title="Returns the entered title text.">getTitle()</a> Retrieves the entered title after dialog acceptance </dd></dl>
<p class="definition">Definition at line <a class="el" href="PGetTitleBlockDialog_8cpp_source.html#l00079">79</a> of file <a class="el" href="PGetTitleBlockDialog_8cpp_source.html">PGetTitleBlockDialog.cpp</a>.</p>
</div>
</div>
<a id="a62b8faf102416014ff1d2f97120ec32c" name="a62b8faf102416014ff1d2f97120ec32c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62b8faf102416014ff1d2f97120ec32c">&#9670;&#160;</a></span>~PGetTitleBlockDialog()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual PGetTitleBlockDialog::~PGetTitleBlockDialog </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Virtual destructor. </p>
<p>Default destructor implementation. Qt's parent-child ownership system handles cleanup of UI elements automatically. </p>
<p class="definition">Definition at line <a class="el" href="PGetTitleBlockDialog_8h_source.html#l00113">113</a> of file <a class="el" href="PGetTitleBlockDialog_8h_source.html">PGetTitleBlockDialog.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a7ff9e6ff81c3d2f00229da59f02302c9" name="a7ff9e6ff81c3d2f00229da59f02302c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ff9e6ff81c3d2f00229da59f02302c9">&#9670;&#160;</a></span>getTitle()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QString PGetTitleBlockDialog::getTitle </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the entered title text. </p>
<p>Retrieves the text currently entered in the title line edit field. This method is typically called after the dialog is accepted to obtain the title string for insertion into the msr file.</p>
<dl class="section return"><dt>Returns</dt><dd>QString containing the title text entered by the user. May be empty if no text was entered. The returned string is trimmed of leading/trailing whitespace by the QLineEdit widget.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The caller should validate that the returned string does not contain newline characters, as msr file titles must be single-line.</dd></dl>
<dl class="section see"><dt>See also</dt><dd>QLineEdit::text() For the underlying widget method </dd></dl>
<p class="definition">Definition at line <a class="el" href="PGetTitleBlockDialog_8h_source.html#l00131">131</a> of file <a class="el" href="PGetTitleBlockDialog_8h_source.html">PGetTitleBlockDialog.h</a>.</p>
</div>
</div>
<a id="add38657c93905eb599afd918845128a9" name="add38657c93905eb599afd918845128a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add38657c93905eb599afd918845128a9">&#9670;&#160;</a></span>helpContent</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void PGetTitleBlockDialog::helpContent </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span><span class="mlabel slot">slot</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Opens the online help for TITLE blocks. </p>
<p>Opens online help documentation for TITLE blocks.</p>
<p>Attempts to open the help URL in the system's default web browser using QDesktopServices. If the URL is empty, displays a placeholder information message. If the browser cannot be opened, shows an error dialog with the URL for manual access.</p>
<p>The help documentation typically covers:</p><ul>
<li>Purpose and format of the TITLE block</li>
<li>Examples of well-formed titles</li>
<li>Best practices for title naming</li>
</ul>
<dl class="section note"><dt>Note</dt><dd>Connected to the help button click signal in the UI.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a87bd554c0c033fb5685810e2ebadc097" title="Constructs a dialog for entering or editing a title.">PGetTitleBlockDialog::PGetTitleBlockDialog()</a> Where helpUrl is set</dd></dl>
<p>Attempts to open the help URL in the user's default web browser using QDesktopServices::openUrl(). The help documentation typically provides:</p><ul>
<li>Explanation of the TITLE block's purpose in msr files</li>
<li>Format specifications and constraints</li>
<li>Examples of well-formed titles for various analysis types</li>
<li>Best practices for creating informative and consistent titles</li>
</ul>
<p>Error handling:</p><ul>
<li>If fHelpUrl is empty: displays an information dialog with a placeholder message indicating that help documentation will be available in the future</li>
<li>If the browser fails to open: displays a critical error dialog with the URL formatted as a clickable hyperlink, allowing users to manually copy and paste the URL into their browser</li>
</ul>
<p>The URL is parsed in TolerantMode, which allows for flexible URL formatting and automatically handles common URL variations (e.g., with or without protocol specification).</p>
<dl class="section note"><dt>Note</dt><dd>This slot is connected to the help button click signal in the UI. </dd>
<dd>
The dialog remains open after help is displayed, allowing users to reference the documentation while entering the title.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="#a87bd554c0c033fb5685810e2ebadc097" title="Constructs a dialog for entering or editing a title.">PGetTitleBlockDialog::PGetTitleBlockDialog()</a> Where <a class="el" href="#a73edf25f9be2907251a5152f1f873633" title="URL to the online documentation for TITLE blocks.">fHelpUrl</a> is initialized </dd>
<dd>
QDesktopServices::openUrl() For the browser opening mechanism </dd></dl>
<p class="definition">Definition at line <a class="el" href="PGetTitleBlockDialog_8cpp_source.html#l00115">115</a> of file <a class="el" href="PGetTitleBlockDialog_8cpp_source.html">PGetTitleBlockDialog.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a73edf25f9be2907251a5152f1f873633" name="a73edf25f9be2907251a5152f1f873633"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73edf25f9be2907251a5152f1f873633">&#9670;&#160;</a></span>fHelpUrl</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">QString PGetTitleBlockDialog::fHelpUrl</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>URL to the online documentation for TITLE blocks. </p>
<p class="definition">Definition at line <a class="el" href="PGetTitleBlockDialog_8h_source.html#l00154">154</a> of file <a class="el" href="PGetTitleBlockDialog_8h_source.html">PGetTitleBlockDialog.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/workspace/LMU/musrfit/src/musredit_qt6/musredit/<a class="el" href="PGetTitleBlockDialog_8h_source.html">PGetTitleBlockDialog.h</a></li>
<li>/workspace/LMU/musrfit/src/musredit_qt6/musredit/<a class="el" href="PGetTitleBlockDialog_8cpp_source.html">PGetTitleBlockDialog.cpp</a></li>
</ul>
</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.13.2
</small></address>
</div><!-- doc-content -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink