123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206 |
- /* =============================================================================
- * PROGRAM: CODE LIBRARY
- * FILENAME: x11_simple_menu.h
- *
- * DESCRIPTION:
- * This module provides a simple menu capability for X11 programs.
- * It can currently only handle a single window/menu at a time.
- * To use this library in an application:
- * 1. Create the widow to contain the menu.
- * 2. Call XMENU_SetMenu to set the menu to be displayed in that window
- * This must provide a pointer to a function to repaint the windows
- * that may be obscured by the menu.
- * 3. Call XMENU_GetMenuHeight to get the height of the menu bar.
- * The application should be acreful not to draw in this area.
- * 4. Add XMENU_EVENT_MASK to the menu window
- * 5. When processing an X event the main event loop should call
- * XMENU_HandleEvent.
- * This function will return either:
- * . -1 if the menu didn
- * application needs to handle it, or
- * . The selected menu item id if the event was handled by the menu.
- * In this case the application shouldn
- * act on the returned menu selection id.
- * 6. Call XMENU_Redraw whenever the window containing the menu gets an
- * expose event.
- *
- * =============================================================================
- * COPYRIGHT:
- *
- * Copyright (c) 2003, Julian Olds
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * . Redistributions of source code must retain the above copyright notice,
- * this list of conditions and the following disclaimer.
- *
- * . Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution.
- *
- * The name of the author may not be used to endorse or promote products
- * derived from this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
- * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
- * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
- * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
- * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
- * THE POSSIBILITY OF SUCH DAMAGE.
- *
- * =============================================================================
- * EXPORTED VARIABLES
- *
- * None.
- *
- * =============================================================================
- * EXPORTED FUNCTIONS
- *
- * XMENU_SetMenu - Set the menu and menu dislay window
- * XMENU_SetCheck - Set the checkmark state for a menu item
- * XMENU_GetMenuHeight - Get the menu height in pixels
- * XMENU_Redraw - Redraw the menu
- * XMENU_HandleEvent - Process input events for the menu selection
- *
- * =============================================================================
- */
- #ifndef __X11_SIMPLE_MENU_H
- #define __X11_SIMPLE_MENU_H
- #include <X11/Xlib.h>
- #define XMENU_NULLID 0
- #define XMENU_SEPARATOR 1
- typedef enum { XMENU_UNCHECKED, XMENU_CHECKED } XMENU_CheckState;
- /*
- * The X events the menu handler requires its window to handle
- */
- #define XMENU_EVENT_MASK \
- (ButtonPressMask | ButtonReleaseMask | Button1MotionMask)
- struct XMENU_Item {
- char *Text;
- int ItemId;
- XMENU_CheckState Checked;
- struct XMENU_Item *Next;
- };
- struct XMENU_Menu {
- char *Text;
- struct XMENU_Menu *Next;
- struct XMENU_Item *ItemList;
- int HitLeft; /* Hit region. Filled out by menu handler. */
- int HitTop; /* These values are for internal use only. */
- int HitWidth;
- int HitHeight;
- };
- /* =============================================================================
- * FUNCTION: XMENU_SetMenu
- *
- * DESCRIPTION:
- * Set the menu to be dislayed in a window.
- *
- * PARAMETERS:
- *
- * dpy : A pointer to the display containing the window
- *
- * win : The window to contain the menu
- *
- * FontSpec : The X font specified string for the menu, or NULL for the
- * default menu font (Helvetica 12).
- *
- * Repaint : A pointer to the function that performs the repainting of
- * windows that may be obscured by the popup menus.
- *
- * RETURN VALUE:
- *
- * None.
- */
- void XMENU_SetMenu(Display *dpy, Window win, struct XMENU_Menu *Menu,
- char *FontSpec, void (*Repaint)(void));
- /* =============================================================================
- * FUNCTION: XMENU_SetCheck
- *
- * DESCRIPTION:
- * Set the checkmark state of a menu item.
- *
- * PARAMETERS:
- *
- * ItemId : The ItemId of the menu item.
- *
- * CheckState : The new check state for the menu item.
- *
- * RETURN VALUE:
- *
- * None.
- */
- void XMENU_SetCheck(int ItemId, XMENU_CheckState CheckState);
- /* =============================================================================
- * FUNCTION: XMENU_GetMenuHeight
- *
- * DESCRIPTION:
- * Get the height of the currently managed menu bar in pixels.
- *
- * PARAMETERS:
- *
- * None.
- *
- * RETURN VALUE:
- *
- * The menu bar height in pixels.
- */
- int XMENU_GetMenuHeight(void);
- /* =============================================================================
- * FUNCTION: XMENU_Redraw
- *
- * DESCRIPTION:
- * Redraw the menu bar.
- *
- * PARAMETERS:
- *
- * None.
- *
- * RETURN VALUE:
- *
- * None.
- */
- void XMENU_Redraw(void);
- /* =============================================================================
- * FUNCTION: XMENU_HandleEvent
- *
- * DESCRIPTION:
- * Perform event handling for the menu.
- * If the X event activates the menu then further X events will be processed
- * until an item is selected or the menu is deactivated.
- *
- * PARAMETERS:
- *
- * Event : The X event to be handled.
- *
- * RETURN VALUE:
- *
- * Returns The selected Menu Item or XMENU_NULLID if the event is handled
- * by the menu.
- * Returns -1 if the event is not handled by the menu.
- */
- int XMENU_HandleEvent(XEvent *Event);
- #endif
|