]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - doc/html/man/mitem_opts.3x.html
ncurses 6.2 - patch 20210619
[ncurses.git] / doc / html / man / mitem_opts.3x.html
index e5aa6d9246094ca512b76ad06ce42be32bbc69d2..0950ddc78f9201db0612c1cd2bc9c31225a2f73b 100644 (file)
@@ -1,7 +1,8 @@
-<!-- 
+<!--
   * t
   ****************************************************************************
-  * Copyright (c) 1998-2010,2015 Free Software Foundation, Inc.              *
+  * Copyright 2018-2019,2020 Thomas E. Dickey                                *
+  * Copyright 1998-2010,2015 Free Software Foundation, Inc.                  *
   *                                                                          *
   * Permission is hereby granted, free of charge, to any person obtaining a  *
   * copy of this software and associated documentation files (the            *
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: mitem_opts.3x,v 1.12 2015/12/05 23:42:45 tom Exp @
+  * @Id: mitem_opts.3x,v 1.16 2020/10/17 23:52:26 tom Exp @
 -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
 <HEAD>
 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
-<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>mitem_opts 3x</TITLE>
-<link rev=made href="mailto:bug-ncurses@gnu.org">
+<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
+<TITLE>mitem_opts 3X</TITLE>
+<link rel="author" href="mailto:bug-ncurses@gnu.org">
 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
 </HEAD>
 <BODY>
-<H1 class="no-header">mitem_opts 3x</H1>
+<H1 class="no-header">mitem_opts 3X</H1>
 <PRE>
-<STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG>                                           <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG>
+<B><A HREF="mitem_opts.3X.html">mitem_opts(3X)</A></B>                                                  <B><A HREF="mitem_opts.3X.html">mitem_opts(3X)</A></B>
 
 
 
 
-</PRE>
-<H2><a name="h2-NAME">NAME</a></H2><PRE>
-       <STRONG>set_item_opts</STRONG>,  <STRONG>item_opts_on</STRONG>,  <STRONG>item_opts_off</STRONG>,  <STRONG>item_opts</STRONG> -
-       set and get menu item options
+</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
+       <B>set_item_opts</B>,  <B>item_opts_on</B>,  <B>item_opts_off</B>,  <B>item_opts</B>  - set and get
+       menu item options
 
 
-</PRE>
-<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
-       <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
-       int set_item_opts(ITEM *item, Item_Options opts);
-       int item_opts_on(ITEM *item, Item_Options opts);
-       int item_opts_off(ITEM *item, Item_Options opts);
-       Item_Options item_opts(const ITEM *item);
+</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
+       <B>#include</B> <B>&lt;menu.h&gt;</B>
 
+       <B>int</B> <B>set_item_opts(ITEM</B> <B>*</B><I>item</I><B>,</B> <B>Item_Options</B> <I>opts</I><B>);</B>
+       <B>Item_Options</B> <B>item_opts(const</B> <B>ITEM</B> <B>*</B><I>item</I><B>);</B>
 
-</PRE>
-<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
-       The function  <STRONG>set_item_opts</STRONG>  sets  all  the  given  item's
-       option  bits  (menu  option  bits  may  be logically-OR'ed
-       together).
+       <B>int</B> <B>item_opts_on(ITEM</B> <B>*</B><I>item</I><B>,</B> <B>Item_Options</B> <I>opts</I><B>);</B>
+       <B>int</B> <B>item_opts_off(ITEM</B> <B>*</B><I>item</I><B>,</B> <B>Item_Options</B> <I>opts</I><B>);</B>
 
-       The function <STRONG>item_opts_on</STRONG> turns on the given option  bits,
-       and leaves others alone.
 
-       The  function  <STRONG>item_opts_off</STRONG>  turns  off  the given option
-       bits, and leaves others alone.
+</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
+       The function <B>set_item_opts</B> sets all the given item's option bits  (menu
+       option bits may be logically-OR'ed together).
 
-       The function <STRONG>item_opts</STRONG> returns the item's  current  option
-       bits.
+       The  function  <B>item_opts_on</B>  turns on the given option bits, and leaves
+       others alone.
 
-       There  is  only one defined option bit mask, <STRONG>O_SELECTABLE</STRONG>.
-       When this is on, the item may be selected during menu pro-
-       cessing.  This option defaults to on.
+       The function <B>item_opts_off</B> turns off the given option bits, and  leaves
+       others alone.
 
+       The function <B>item_opts</B> returns the item's current option bits.
 
-</PRE>
-<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
-       Except for <STRONG>item_opts</STRONG>, each routine returns one of the fol-
-       lowing:
+       There  is only one defined option bit mask, <B>O_SELECTABLE</B>.  When this is
+       on, the item may be  selected  during  menu  processing.   This  option
+       defaults to on.
 
-       <STRONG>E_OK</STRONG> The routine succeeded.
 
-       <STRONG>E_SYSTEM_ERROR</STRONG>
-            System error occurred (see <STRONG>errno</STRONG>).
+</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
+       Except for <B>item_opts</B>, each routine returns one of the following:
 
+       <B>E_OK</B> The routine succeeded.
 
-</PRE>
-<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
-       <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
+       <B>E_SYSTEM_ERROR</B>
+            System error occurred (see <B>errno(3)</B>).
 
 
-</PRE>
-<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
-       The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
-       file <STRONG>&lt;curses.h&gt;</STRONG>.
+</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
+       <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="menu.3X.html">menu(3X)</A></B>.
 
 
-</PRE>
-<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
-       These  routines  emulate  the System V menu library.  They
-       were not supported on Version 7 or BSD versions.
+</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
+       The  header  file  <B>&lt;menu.h&gt;</B>  automatically  includes  the  header  file
+       <B>&lt;curses.h&gt;</B>.
 
 
-</PRE>
-<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
-       Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
-       curses by Eric S. Raymond.
+</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
+       These routines emulate the  System  V  menu  library.   They  were  not
+       supported on Version 7 or BSD versions.
+
+
+</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
+       Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
+       Raymond.
 
 
 
-                                                         <STRONG><A HREF="mitem_opts.3x.html">mitem_opts(3x)</A></STRONG>
+                                                                <B><A HREF="mitem_opts.3X.html">mitem_opts(3X)</A></B>
 </PRE>
 <div class="nav">
 <ul>