/usr/share/doc/wireshark-doc/wsdg_html_chunked/lua_module

<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>11.3. GUI support</title><link rel="stylesheet" type="text/css" href="ws.css"><meta name="generator" content="DocBook XSL Stylesheets V1.79.1"><link rel="home" href="index.html" title="Wireshark Developer&#8217;s Guide"><link rel="up" href="wsluarm_modules.html" title="Chapter 11. Wireshark&#8217;s Lua API Reference Manual"><link rel="prev" href="lua_module_Field.html" title="11.2. Obtaining dissection data"><link rel="next" href="lua_module_Listener.html" title="11.4. Post-dissection packet analysis"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">11.3. GUI support</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="lua_module_Field.html">Prev</a> </td><th width="60%" align="center">Chapter 11. Wireshark&#8217;s Lua API Reference Manual</th><td width="20%" align="right"> <a accesskey="n" href="lua_module_Listener.html">Next</a></td></tr></table><hr></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="lua_module_Gui"></a>11.3. GUI support</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="lua_class_ProgDlg"></a>11.3.1. ProgDlg</h3></div></div></div><p>Manages a progress bar dialog.</p><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_ProgDlg_new__title____task__"></a>11.3.1.1. ProgDlg.new([title], [task])</h4></div></div></div><p>Creates a new <code class="literal">ProgDlg</code> progress dialog.</p><h5><a name="_arguments_8"></a>Arguments</h5><div class="variablelist"><dl class="variablelist"><dt><span class="term">
title (optional)
</span></dt><dd>
Title of the new window, defaults to "Progress".
</dd><dt><span class="term">
task (optional)
</span></dt><dd>
Current task, defaults to "".
</dd></dl></div><h5><a name="_returns_10"></a>Returns</h5><p>The newly created <code class="literal">ProgDlg</code> object.</p></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_progdlg_update_progress___task__"></a>11.3.1.2. progdlg:update(progress, [task])</h4></div></div></div><p>Appends text.</p><h5><a name="_arguments_9"></a>Arguments</h5><div class="variablelist"><dl class="variablelist"><dt><span class="term">
progress
</span></dt><dd>
Part done ( e.g. 0.75 ).
</dd><dt><span class="term">
task (optional)
</span></dt><dd>
Current task, defaults to "".
</dd></dl></div><h5><a name="_errors_9"></a>Errors</h5><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
GUI not available
</li><li class="listitem">
Cannot be called for something not a ProgDlg
</li><li class="listitem">
Progress value out of range (must be between 0.0 and 1.0)

</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_progdlg_stopped__"></a>11.3.1.3. progdlg:stopped()</h4></div></div></div><p>Checks whether the user has pressed the stop button.</p><h5><a name="_returns_11"></a>Returns</h5><p>true if the user has asked to stop the progress.</p></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_progdlg_close__"></a>11.3.1.4. progdlg:close()</h4></div></div></div><p>Closes the progress dialog.</p><h5><a name="_returns_12"></a>Returns</h5><p>A string specifying whether the Progress Dialog has stopped or not.</p><h5><a name="_errors_10"></a>Errors</h5><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
GUI not available

</li></ul></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="lua_class_TextWindow"></a>11.3.2. TextWindow</h3></div></div></div><p>Manages a text window.</p><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_TextWindow_new__title__"></a>11.3.2.1. TextWindow.new([title])</h4></div></div></div><p>Creates a new <code class="literal">TextWindow</code> text window.</p><h5><a name="_arguments_10"></a>Arguments</h5><div class="variablelist"><dl class="variablelist"><dt><span class="term">
title (optional)
</span></dt><dd>
Title of the new window.
</dd></dl></div><h5><a name="_returns_13"></a>Returns</h5><p>The newly created <code class="literal">TextWindow</code> object.</p><h5><a name="_errors_11"></a>Errors</h5><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
GUI not available

</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_textwindow_set_atclose_action_"></a>11.3.2.2. textwindow:set_atclose(action)</h4></div></div></div><p>Set the function that will be called when the text window closes.</p><h5><a name="_arguments_11"></a>Arguments</h5><div class="variablelist"><dl class="variablelist"><dt><span class="term">
action
</span></dt><dd>
A Lua function to be executed when the user closes the text window.
</dd></dl></div><h5><a name="_returns_14"></a>Returns</h5><p>The <code class="literal">TextWindow</code> object.</p><h5><a name="_errors_12"></a>Errors</h5><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
GUI not available

</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_textwindow_set_text_"></a>11.3.2.3. textwindow:set(text)</h4></div></div></div><p>Sets the text.</p><h5><a name="_arguments_12"></a>Arguments</h5><div class="variablelist"><dl class="variablelist"><dt><span class="term">
text
</span></dt><dd>
The text to be used.
</dd></dl></div><h5><a name="_returns_15"></a>Returns</h5><p>The <code class="literal">TextWindow</code> object.</p><h5><a name="_errors_13"></a>Errors</h5><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
GUI not available

</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_textwindow_append_text_"></a>11.3.2.4. textwindow:append(text)</h4></div></div></div><p>Appends text</p><h5><a name="_arguments_13"></a>Arguments</h5><div class="variablelist"><dl class="variablelist"><dt><span class="term">
text
</span></dt><dd>
The text to be appended
</dd></dl></div><h5><a name="_returns_16"></a>Returns</h5><p>The <code class="literal">TextWindow</code> object.</p><h5><a name="_errors_14"></a>Errors</h5><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
GUI not available

</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_textwindow_prepend_text_"></a>11.3.2.5. textwindow:prepend(text)</h4></div></div></div><p>Prepends text</p><h5><a name="_arguments_14"></a>Arguments</h5><div class="variablelist"><dl class="variablelist"><dt><span class="term">
text
</span></dt><dd>
The text to be appended
</dd></dl></div><h5><a name="_returns_17"></a>Returns</h5><p>The <code class="literal">TextWindow</code> object.</p><h5><a name="_errors_15"></a>Errors</h5><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
GUI not available

</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_textwindow_clear__"></a>11.3.2.6. textwindow:clear()</h4></div></div></div><p>Erases all text in the window.</p><h5><a name="_returns_18"></a>Returns</h5><p>The TextWindow object.</p><h5><a name="_errors_16"></a>Errors</h5><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
GUI not available

</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_textwindow_get_text__"></a>11.3.2.7. textwindow:get_text()</h4></div></div></div><p>Get the text of the window</p><h5><a name="_returns_19"></a>Returns</h5><p>The `TextWindow&#8217;s text.</p><h5><a name="_errors_17"></a>Errors</h5><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
GUI not available

</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_textwindow_close__"></a>11.3.2.8. textwindow:close()</h4></div></div></div><p>Close the window</p><h5><a name="_errors_18"></a>Errors</h5><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
GUI not available

</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_textwindow_set_editable__editable__"></a>11.3.2.9. textwindow:set_editable([editable])</h4></div></div></div><p>Make this text window editable.</p><h5><a name="_arguments_15"></a>Arguments</h5><div class="variablelist"><dl class="variablelist"><dt><span class="term">
editable (optional)
</span></dt><dd>
A boolean flag, defaults to true.
</dd></dl></div><h5><a name="_returns_20"></a>Returns</h5><p>The <code class="literal">TextWindow</code> object.</p><h5><a name="_errors_19"></a>Errors</h5><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
GUI not available

</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_textwindow_add_button_label__function_"></a>11.3.2.10. textwindow:add_button(label, function)</h4></div></div></div><p>Adds a button to the text window.</p><h5><a name="_arguments_16"></a>Arguments</h5><div class="variablelist"><dl class="variablelist"><dt><span class="term">
label
</span></dt><dd>
The label of the button
</dd><dt><span class="term">
function
</span></dt><dd>
The Lua function to be called when clicked
</dd></dl></div><h5><a name="_returns_21"></a>Returns</h5><p>The <code class="literal">TextWindow</code> object.</p><h5><a name="_errors_20"></a>Errors</h5><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
GUI not available

</li></ul></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a name="global_functions_Gui"></a>11.3.3. Global Functions</h3></div></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_gui_enabled__"></a>11.3.3.1. gui_enabled()</h4></div></div></div><p>Checks whether the GUI facility is enabled.</p><h5><a name="_returns_22"></a>Returns</h5><p>A boolean: true if it is enabled, false if it isn&#8217;t.</p></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_register_menu_name__action___group__"></a>11.3.3.2. register_menu(name, action, [group])</h4></div></div></div><p>Register a menu item in one of the main menus.</p><h5><a name="_arguments_17"></a>Arguments</h5><div class="variablelist"><dl class="variablelist"><dt><span class="term">
name
</span></dt><dd>
The name of the menu item. The submenus are to be separated by '`/&#8217;s. (string)
</dd><dt><span class="term">
action
</span></dt><dd>
The function to be called when the menu item is invoked. (function taking no arguments and returning nothing)
</dd><dt><span class="term">
group (optional)
</span></dt><dd><p class="simpara">
The menu group into which the menu item is to be inserted. If omitted, defaults to MENU_STAT_GENERIC. One of:
</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
MENU_STAT_UNSORTED (Statistics),
</li><li class="listitem">
MENU_STAT_GENERIC (Statistics, first section),
</li><li class="listitem">
MENU_STAT_CONVERSATION (Statistics/Conversation List),
</li><li class="listitem">
MENU_STAT_ENDPOINT (Statistics/Endpoint List),
</li><li class="listitem">
MENU_STAT_RESPONSE (Statistics/Service Response Time),
</li><li class="listitem">
MENU_STAT_TELEPHONY (Telephony),
</li><li class="listitem">
MENU_STAT_TELEPHONY_GSM (Telephony/GSM),
</li><li class="listitem">
MENU_STAT_TELEPHONY_LTE (Telephony/LTE),
</li><li class="listitem">
MENU_STAT_TELEPHONY_SCTP (Telephony/SCTP),
</li><li class="listitem">
MENU_ANALYZE (Analyze),
</li><li class="listitem">
MENU_ANALYZE_CONVERSATION (Analyze/Conversation Filter),
</li><li class="listitem">
MENU_TOOLS_UNSORTED (Tools). (number)
</li></ul></div></dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_new_dialog_title__action______"></a>11.3.3.3. new_dialog(title, action, &#8230;)</h4></div></div></div><p>Pops up a new dialog</p><h5><a name="_arguments_18"></a>Arguments</h5><div class="variablelist"><dl class="variablelist"><dt><span class="term">
title
</span></dt><dd>
Title of the dialog&#8217;s window.
</dd><dt><span class="term">
action
</span></dt><dd>
Action to be performed when OK&#8217;d.
</dd><dt><span class="term">
&#8230;
</span></dt><dd>
A series of strings to be used as labels of the dialog&#8217;s fields.
</dd></dl></div><h5><a name="_errors_21"></a>Errors</h5><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
GUI not available
</li><li class="listitem">
At least one field required
</li><li class="listitem">
All fields must be strings

</li></ul></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_retap_packets__"></a>11.3.3.4. retap_packets()</h4></div></div></div><p>Rescan all packets and just run taps - don&#8217;t reconstruct the display.</p></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_copy_to_clipboard_text_"></a>11.3.3.5. copy_to_clipboard(text)</h4></div></div></div><p>Copy a string into the clipboard.</p><h5><a name="_arguments_19"></a>Arguments</h5><div class="variablelist"><dl class="variablelist"><dt><span class="term">
text
</span></dt><dd>
The string to be copied into the clipboard.
</dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_open_capture_file_filename__filter_"></a>11.3.3.6. open_capture_file(filename, filter)</h4></div></div></div><p>Open and display a capture file.</p><h5><a name="_arguments_20"></a>Arguments</h5><div class="variablelist"><dl class="variablelist"><dt><span class="term">
filename
</span></dt><dd>
The name of the file to be opened.
</dd><dt><span class="term">
filter
</span></dt><dd>
A filter to be applied as the file gets opened.
</dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_get_filter__"></a>11.3.3.7. get_filter()</h4></div></div></div><p>Get the main filter text.</p></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_set_filter_text_"></a>11.3.3.8. set_filter(text)</h4></div></div></div><p>Set the main filter text.</p><h5><a name="_arguments_21"></a>Arguments</h5><div class="variablelist"><dl class="variablelist"><dt><span class="term">
text
</span></dt><dd>
The filter&#8217;s text.
</dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_set_color_filter_slot_row__text_"></a>11.3.3.9. set_color_filter_slot(row, text)</h4></div></div></div><p>Set packet-coloring rule for the current session.</p><h5><a name="_arguments_22"></a>Arguments</h5><div class="variablelist"><dl class="variablelist"><dt><span class="term">
row
</span></dt><dd>
The index of the desired color in the temporary coloring rules list.
</dd><dt><span class="term">
text
</span></dt><dd>
Display filter for selecting packets to be colorized.
</dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_apply_filter__"></a>11.3.3.10. apply_filter()</h4></div></div></div><p>Apply the filter in the main filter box.</p></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_reload__"></a>11.3.3.11. reload()</h4></div></div></div><p>Reload the current capture file.</p></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_browser_open_url_url_"></a>11.3.3.12. browser_open_url(url)</h4></div></div></div><p>Open an url in a browser.</p><h5><a name="_arguments_23"></a>Arguments</h5><div class="variablelist"><dl class="variablelist"><dt><span class="term">
url
</span></dt><dd>
The url.
</dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h4 class="title"><a name="lua_fn_browser_open_data_file_filename_"></a>11.3.3.13. browser_open_data_file(filename)</h4></div></div></div><p>Open a file in a browser.</p><h5><a name="_arguments_24"></a>Arguments</h5><div class="variablelist"><dl class="variablelist"><dt><span class="term">
filename
</span></dt><dd>
The file name.
</dd></dl></div></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="lua_module_Field.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="wsluarm_modules.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="lua_module_Listener.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">11.2. Obtaining dissection data </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> 11.4. Post-dissection packet analysis</td></tr></table></div></body></html>
wireshark-doc 2.0.2+ga16e22e-1 / usr / share / doc / wireshark-doc / wsdg_html_chunked / lua_module_Gui.html
