summaryrefslogtreecommitdiffstats
path: root/ncurses-5.2/doc/html/man/menu_mark.3x.html
diff options
context:
space:
mode:
Diffstat (limited to 'ncurses-5.2/doc/html/man/menu_mark.3x.html')
-rw-r--r--ncurses-5.2/doc/html/man/menu_mark.3x.html82
1 files changed, 82 insertions, 0 deletions
diff --git a/ncurses-5.2/doc/html/man/menu_mark.3x.html b/ncurses-5.2/doc/html/man/menu_mark.3x.html
new file mode 100644
index 0000000..f2eeac9
--- /dev/null
+++ b/ncurses-5.2/doc/html/man/menu_mark.3x.html
@@ -0,0 +1,82 @@
+<HTML>
+<BODY>
+<PRE>
+<!-- Manpage converted by man2html 3.0.1 -->
+
+</PRE>
+<H2>NAME</H2><PRE>
+ <B>menu_mark</B> - get and set the menu mark string
+
+
+</PRE>
+<H2>SYNOPSIS</H2><PRE>
+ <B>#include</B> <B>&lt;menu.h&gt;</B>
+ int set_menu_mark(MENU *menu, const char *mark);
+ const char *menu_mark(const MENU *menu);
+
+
+</PRE>
+<H2>DESCRIPTION</H2><PRE>
+ In order to make menu selections visible on older termi-
+ nals without highlighting or color capability, the menu
+ library marks selected items in a menu with a prefix
+ string.
+
+ The function <B>set_menu_mark</B> sets the mark string for the
+ given menu. Calling <B>set_menu_mark</B> with a null menu item
+ will abolish the mark string. Note that changing the
+ length of the mark string for a menu while the menu is
+ posted is likely to produce unhelpful behavior.
+
+ The default string is "-" (a dash). Calling <B>set_menu_mark</B>
+ with a <B>NULL</B> menu argument will change this default.
+
+ The function <B>menu_mark</B> returns the menu's mark string (or
+ <B>NULL</B> if there is none).
+
+
+</PRE>
+<H2>RETURN VALUE</H2><PRE>
+ The function <B>menu_mark</B> returns <B>NULL</B> on error. The func-
+ tion <B>set_menu_mark</B> may return the following error codes:
+
+ <B>E_OK</B> The routine succeeded.
+
+ <B>E_SYSTEM_ERROR</B>
+ System error occurred (see <B>errno</B>).
+
+ <B>E_BAD_ARGUMENT</B>
+ Routine detected an incorrect or out-of-range argu-
+ ment.
+
+
+</PRE>
+<H2>SEE ALSO</H2><PRE>
+ <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>.
+
+
+</PRE>
+<H2>NOTES</H2><PRE>
+ The header file <B>&lt;menu.h&gt;</B> automatically includes the header
+ file <B>&lt;curses.h&gt;</B>.
+
+
+</PRE>
+<H2>PORTABILITY</H2><PRE>
+ These routines emulate the System V menu library. They
+ were not supported on Version 7 or BSD versions.
+
+
+</PRE>
+<H2>AUTHORS</H2><PRE>
+ Juergen Pfeifer. Manual pages and adaptation for new
+ curses by Eric S. Raymond.
+
+</PRE>
+<HR>
+<ADDRESS>
+Man(1) output converted with
+<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
+</ADDRESS>
+</BODY>
+</HTML>