menu.h File Reference

#include <Python.h>

Include dependency graph for menu.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
PyObject *	py_add_menu_item (PyObject *self, PyObject *args)
PyObject *	py_add_menu_separator (PyObject *self, PyObject *args)
PyObject *	py_create_menu (PyObject *self, PyObject *args)
PyObject *	py_delete_menu (PyObject *self, PyObject *args)
PyObject *	py_popup_menu (PyObject *self, PyObject *args)
PyObject *	py_remove_menu_item (PyObject *self, PyObject *args)

Function Documentation

PyObject* py_add_menu_item	(	PyObject *	self,
		PyObject *	args
	)

Menu/addMenuItem.

SYNOPSIS long addMenuItem(widget, menu, text, icon) DESCRIPTION This adds an entry to the given menu with label text and with given icon. icon can be just an application name in which case the user's current icon set is used, or can be a path to a 16x16 png file.

The function returns the id of the menu item, which identifies that popup menu item uniquely among popupmenu items application-wide or returns 0 if the given menu doesn't exist. ARGUMENTS

• long widget – karamba
• long menu – pointer to menu
• string text – text for menu item
• string icon – icon RETURN VALUE menu item id

Definition at line 99 of file menu.cpp.

PyObject* py_add_menu_separator	(	PyObject *	self,
		PyObject *	args
	)

Menu/addMenuSeparator.

SYNOPSIS long addMenuSeparator(widget, menu) DESCRIPTION This adds an menu separator to the given menu. ARGUMENTS

• long widget – karamba
• long menu – pointer to menu RETURN VALUE menu item id

Definition at line 126 of file menu.cpp.

PyObject* py_create_menu	(	PyObject *	self,
		PyObject *	args
	)

Menu/createMenu.

SYNOPSIS long createMenu(widget) DESCRIPTION This creates an empty popup menu and returns a pointer to the menu. ARGUMENTS

• long widget – karamba RETURN VALUE pointer to menu

Definition at line 53 of file menu.cpp.

PyObject* py_delete_menu	(	PyObject *	self,
		PyObject *	args
	)

Menu/deleteMenu.

SYNOPSIS long deleteMenu(widget, menu) DESCRIPTION This deletes the referenced menu if that menu exists. ARGUMENTS

• long widget – karamba
• long menu – pointer to menu RETURN VALUE 1 if menu existed and was deleted, returns 0 otherwise.

Definition at line 78 of file menu.cpp.

PyObject* py_popup_menu	(	PyObject *	self,
		PyObject *	args
	)

Menu/popupMenu.

SYNOPSIS long popupMenu(widget, menu, x, y) DESCRIPTION This pops up the given menu at the given co-ordinates. The co-ordinates are relative to the widget, not the screen. You can use negative co-ordinates to make a menu appear to the right of or above your theme. ARGUMENTS

• long widget – karamba
• long menu – pointer to menu
• long x – x coordinate
• long y – y coordinate RETURN VALUE 1 if the menu existed and was popped up, returns 0 otherwise.

Definition at line 172 of file menu.cpp.

PyObject* py_remove_menu_item	(	PyObject *	self,
		PyObject *	args
	)

Menu/removeMenuItem.

SYNOPSIS long removeMenuItem(widget, menu, id) DESCRIPTION This removes the item with given id from given menu if that menu exists. ARGUMENTS

• long widget – karamba
• long menu – pointer to menu
• long id – menu item id RETURN VALUE 1 if the menu item existed and was removed or returns zero otherwise.

Definition at line 150 of file menu.cpp.