summary refs log tree commit diff stats
path: root/doc/pydoc/ranger.gui.html
blob: 8153e361c64cb9dc88a0ab3aaa5ba8b0911080e1 (plain) (blame) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: package ranger.gui</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">

<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="ranger.html"><font color="#ffffff">ranger</font></a>.gui</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/hut/code/ranger/ranger/gui/__init__.py">/home/hut/code/ranger/ranger/gui/__init__.py</a></font></td></tr></table>
    <p></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
    
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="ranger.gui.bar.html">bar</a><br>
<a href="ranger.gui.color.html">color</a><br>
<a href="ranger.gui.colorscheme.html">colorscheme</a><br>
</td><td width="25%" valign=top><a href="ranger.gui.context.html">context</a><br>
<a href="ranger.gui.curses_shortcuts.html">curses_shortcuts</a><br>
<a href="ranger.gui.defaultui.html">defaultui</a><br>
</td><td width="25%" valign=top><a href="ranger.gui.displayable.html">displayable</a><br>
<a href="ranger.gui.mouse_event.html">mouse_event</a><br>
<a href="ranger.gui.ui.html">ui</a><br>
</td><td width="25%" valign=top><a href="ranger.gui.widgets.html"><strong>widgets</strong>&nbsp;(package)</a><br>
</td></tr></table></td></tr></table>
</body></html>
generated by cgit-pink 1.4.1-2-gfad0 (git 2.36.2.497.gbbea4dcf42) at 2025-05-07 08:26:03 +0000
am key The string used to initiate autocompletion @param items The to autocomplete with */ void prof_register_ac(const char *key, char **items); /** Send a desktop notification. @param message The message to show in the notification @param timeout_ms Time in milliseconds until the notification disappears @param category Used as a notification category of the system supports it */ void prof_notify(const char *message, int timeout_ms, const char *category); /** Send input to Profanity, equivalent to if the user had entered it. @param line The input to send. */ void prof_send_line(char *line); /** Get the current recipient if in a chat window. @return The JID of the recipient, or NULL if not in a chat window */ char* prof_get_current_recipient(void); /** Get the current room if in a MUC window. @return The JID of the room, or NULL if not in a MUC window */ char* prof_get_current_muc(void); /** Determines if the current window is the console. @return 1 if in the console, 0 otherwise */ int prof_current_win_is_console(void); /** Log a DEBUG message to the profanity log @param message The message to log */ void prof_log_debug(const char *message); /** Log a INFO message to the profanity log @param message The message to log */ void prof_log_info(const char *message); /** Log a WARNING message to the profanity log @param message The message to log */ void prof_log_warning(const char *message); /** Log a ERROR message to the profanity log @param message The message to log */ void prof_log_error(const char *message); /** Determine if window exist with PROF_WIN_TAG @param win The {@link PROF_WIN_TAG} to check @return 1 if the window exists, 0 otherwise */ int prof_win_exists(PROF_WIN_TAG win); /** Create a new window @param win The {@link PROF_WIN_TAG} for the window @param input_handler The WINDOW_CB function to call when input is received for that window */ void prof_win_create(PROF_WIN_TAG win, WINDOW_CB input_handler); /** Focus a window @param win The {@link PROF_WIN_TAG} of the window to focus @return 1 on success, 0 on failure */ int prof_win_focus(PROF_WIN_TAG win); /** Show a line in a window @param win The {@link PROF_WIN_TAG} of the window @param line The line to print @return 1 on success, 0 on failure */ int prof_win_show(PROF_WIN_TAG win, char *line); /** Show a message in a window, using the specified theme. Themes can be must be specified in ~/.local/share/profanity/plugin_themes @param win The {@link PROF_WIN_TAG} to print to @param group The group name in the themes file, or NULL @param item The item name within the group, or NULL @param def A default colour if the theme cannot be found, or NULL @param message the message to print @return 1 on success, 0 on failure */ int prof_win_show_themed(PROF_WIN_TAG tag, char *group, char *key, char *def, char *line);
generated by cgit-pink 1.4.1-2-gfad0 (git 2.36.2.497.gbbea4dcf42) at 2025-05-07 08:26:03 +0000