doc/html/man/menu_mark.3x.html

   1 <HTML>
   2 <BODY>
   3 <PRE>
   4 <!-- Manpage converted by man2html 3.0.1 -->
   5
   6 </PRE>
   7 <H2>NAME</H2><PRE>
   8        <B>menu_mark</B> - get and set the menu mark string
   9
  10
  11 </PRE>
  12 <H2>SYNOPSIS</H2><PRE>
  13        <B>#include</B> <B>&lt;menu.h&gt;</B>
  14        int set_menu_mark(MENU *menu, const char *mark);
  15        const char *menu_mark(const MENU *menu);
  16
  17
  18 </PRE>
  19 <H2>DESCRIPTION</H2><PRE>
  20        In  order  to make menu selections visible on older termi-
  21        nals without highlighting or color  capability,  the  menu
  22        library  marks  selected  items  in  a  menu with a prefix
  23        string.
  24
  25        The function <B>set_menu_mark</B> sets the mark  string  for  the
  26        given  menu.   Calling <B>set_menu_mark</B> with a null menu item
  27        will abolish the mark  string.   Note  that  changing  the
  28        length  of  the  mark  string for a menu while the menu is
  29        posted is likely to produce unhelpful behavior.
  30
  31        The default string is "-" (a dash). Calling  <B>set_menu_mark</B>
  32        with a <B>NULL</B> menu argument will change this default.
  33
  34        The  function <B>menu_mark</B> returns the menu's mark string (or
  35        <B>NULL</B> if there is none).
  36
  37
  38 </PRE>
  39 <H2>RETURN VALUE</H2><PRE>
  40        The function <B>menu_mark</B> returns <B>NULL</B> on error.   The  func-
  41        tion <B>set_menu_mark</B> may return the following error codes:
  42
  43        <B>E_OK</B> The routine succeeded.
  44
  45        <B>E_SYSTEM_ERROR</B>
  46             System error occurred (see <B>errno</B>).
  47
  48        <B>E_BAD_ARGUMENT</B>
  49             Routine  detected  an incorrect or out-of-range argu-
  50             ment.
  51
  52
  53 </PRE>
  54 <H2>SEE ALSO</H2><PRE>
  55        <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>.
  56
  57
  58 </PRE>
  59 <H2>NOTES</H2><PRE>
  60        The header file <B>&lt;menu.h&gt;</B> automatically includes the header
  61        file <B>&lt;curses.h&gt;</B>.
  62
  63
  64 </PRE>
  65 <H2>PORTABILITY</H2><PRE>
  66        These  routines  emulate  the System V menu library.  They
  67        were not supported on Version 7 or BSD versions.
  68
  69
  70 </PRE>
  71 <H2>AUTHORS</H2><PRE>
  72        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
  73        curses by Eric S. Raymond.
  74
  75 </PRE>
  76 <HR>
  77 <ADDRESS>
  78 Man(1) output converted with
  79 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
  80 </ADDRESS>
  81 </BODY>
  82 </HTML>