Source

pygame / src / doc / event_doc.h

Full commit
/* Auto generated file: with makeref.py .  Docs go in src/ *.doc . */
#define DOC_PYGAMEEVENT "pygame module for interacting with events and queues"

#define DOC_PYGAMEEVENTPUMP "pump() -> None\ninternally process pygame event handlers"

#define DOC_PYGAMEEVENTGET "get() -> Eventlist\nget(type) -> Eventlist\nget(typelist) -> Eventlist\nget events from the queue"

#define DOC_PYGAMEEVENTPOLL "poll() -> EventType instance\nget a single event from the queue"

#define DOC_PYGAMEEVENTWAIT "wait() -> EventType instance\nwait for a single event from the queue"

#define DOC_PYGAMEEVENTPEEK "peek(type) -> bool\npeek(typelist) -> bool\ntest if event types are waiting on the queue"

#define DOC_PYGAMEEVENTCLEAR "clear() -> None\nclear(type) -> None\nclear(typelist) -> None\nremove all events from the queue"

#define DOC_PYGAMEEVENTEVENTNAME "event_name(type) -> string\nget the string name from and event id"

#define DOC_PYGAMEEVENTSETBLOCKED "set_blocked(type) -> None\nset_blocked(typelist) -> None\nset_blocked(None) -> None\ncontrol which events are allowed on the queue"

#define DOC_PYGAMEEVENTSETALLOWED "set_allowed(type) -> None\nset_allowed(typelist) -> None\nset_allowed(None) -> None\ncontrol which events are allowed on the queue"

#define DOC_PYGAMEEVENTGETBLOCKED "get_blocked(type) -> bool\ntest if a type of event is blocked from the queue"

#define DOC_PYGAMEEVENTSETGRAB "set_grab(bool) -> None\ncontrol the sharing of input devices with other applications"

#define DOC_PYGAMEEVENTGETGRAB "get_grab() -> bool\ntest if the program is sharing input devices"

#define DOC_PYGAMEEVENTPOST "post(Event) -> None\nplace a new event on the queue"

#define DOC_PYGAMEEVENTEVENT "Event(type, dict) -> EventType instance\nEvent(type, **attributes) -> EventType instance\ncreate a new event object"

#define DOC_PYGAMEEVENTEVENTTYPE "pygame object for representing SDL events"

#define DOC_EVENTTYPETYPE "type -> int\nSDL event type identifier."

#define DOC_EVENTTYPEDICT "__dict__ -> dict\nEvent object attribute dictionary"



/* Docs in a comment... slightly easier to read. */

/*

pygame.event
pygame module for interacting with events and queues

pygame.event.pump
 pump() -> None
internally process pygame event handlers

pygame.event.get
 get() -> Eventlist
 get(type) -> Eventlist
 get(typelist) -> Eventlist
get events from the queue

pygame.event.poll
 poll() -> EventType instance
get a single event from the queue

pygame.event.wait
 wait() -> EventType instance
wait for a single event from the queue

pygame.event.peek
 peek(type) -> bool
 peek(typelist) -> bool
test if event types are waiting on the queue

pygame.event.clear
 clear() -> None
 clear(type) -> None
 clear(typelist) -> None
remove all events from the queue

pygame.event.event_name
 event_name(type) -> string
get the string name from and event id

pygame.event.set_blocked
 set_blocked(type) -> None
 set_blocked(typelist) -> None
 set_blocked(None) -> None
control which events are allowed on the queue

pygame.event.set_allowed
 set_allowed(type) -> None
 set_allowed(typelist) -> None
 set_allowed(None) -> None
control which events are allowed on the queue

pygame.event.get_blocked
 get_blocked(type) -> bool
test if a type of event is blocked from the queue

pygame.event.set_grab
 set_grab(bool) -> None
control the sharing of input devices with other applications

pygame.event.get_grab
 get_grab() -> bool
test if the program is sharing input devices

pygame.event.post
 post(Event) -> None
place a new event on the queue

pygame.event.Event
 Event(type, dict) -> EventType instance
 Event(type, **attributes) -> EventType instance
create a new event object

pygame.event.EventType
pygame object for representing SDL events

pygame.event.EventType.type
 type -> int
SDL event type identifier.

pygame.event.EventType.__dict__
 __dict__ -> dict
Event object attribute dictionary

*/