X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fmitem_opts.3x;h=716584c899a410cdbbb9d3b3120df0fb0c967241;hb=3183ac61c6bf0a75ee65dc8cbebf54f7c143df46;hp=37ea552328f6deb348d6435c3053337abcc80603;hpb=96d6b16de0d487e5d3aed0302a179dbce11b5d96;p=ncurses.git diff --git a/man/mitem_opts.3x b/man/mitem_opts.3x index 37ea5523..716584c8 100644 --- a/man/mitem_opts.3x +++ b/man/mitem_opts.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2007,2010 Free Software Foundation, Inc. * +.\" Copyright 2018-2021,2022 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 * @@ -27,52 +28,57 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: mitem_opts.3x,v 1.11 2010/12/04 18:40:45 tom Exp $ +.\" $Id: mitem_opts.3x,v 1.19 2022/02/12 20:02:20 tom Exp $ .TH mitem_opts 3X "" .SH NAME -\fBmitem_opts\fR \- set and get menu item options +\fBset_item_opts\fP, +\fBitem_opts_on\fP, +\fBitem_opts_off\fP, +\fBitem_opts\fP \- set and get menu item options .SH SYNOPSIS -\fB#include \fR +\fB#include \fP +.sp +\fBint set_item_opts(ITEM *\fIitem\fB, Item_Options \fIopts\fB);\fR .br -int set_item_opts(ITEM *item, Item_Options opts); +\fBItem_Options item_opts(const ITEM *\fIitem\fB);\fR +.sp +\fBint item_opts_on(ITEM *\fIitem\fB, Item_Options \fIopts\fB);\fR .br -int item_opts_on(ITEM *item, Item_Options opts); -.br -int item_opts_off(ITEM *item, Item_Options opts); -.br -Item_Options item_opts(const ITEM *item); +\fBint item_opts_off(ITEM *\fIitem\fB, Item_Options \fIopts\fB);\fR .br .SH DESCRIPTION -The function \fBset_item_opts\fR sets all the given item's option bits (menu +The function \fBset_item_opts\fP sets all the given item's option bits (menu option bits may be logically-OR'ed together). .PP -The function \fBitem_opts_on\fR turns on the given option bits, and leaves +The function \fBitem_opts_on\fP turns on the given option bits, and leaves others alone. .PP -The function \fBitem_opts_off\fR turns off the given option bits, and leaves +The function \fBitem_opts_off\fP turns off the given option bits, and leaves others alone. .PP -The function \fBitem_opts\fR returns the item's current option bits. +The function \fBitem_opts\fP returns the item's current option bits. .PP -There is only one defined option bit mask, \fBO_SELECTABLE\fR. When this is -on, the item may be selected during menu processing. This option defaults +There is only one defined option bit mask, \fBO_SELECTABLE\fP. When this is +on, the item may be selected during menu processing. +This option defaults to on. .SH RETURN VALUE -Except for \fBitem_opts\fR, each routine returns one of the following: +Except for \fBitem_opts\fP, each routine returns one of the following: .TP 5 .B E_OK The routine succeeded. .TP 5 .B E_SYSTEM_ERROR -System error occurred (see \fBerrno\fR). +System error occurred (see \fBerrno\fP(3)). .SH SEE ALSO -\fBcurses\fR(3X), \fBmenu\fR(3X). +\fBcurses\fP(3X), \fBmenu\fP(3X). .SH NOTES -The header file \fB\fR automatically includes the header file -\fB\fR. +The header file \fB\fP automatically includes the header file +\fB\fP. .SH PORTABILITY -These routines emulate the System V menu library. They were not supported on +These routines emulate the System V menu library. +They were not supported on Version 7 or BSD versions. .SH AUTHORS -Juergen Pfeifer. Manual pages and adaptation for new curses by Eric -S. Raymond. +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.