popup_struct Struct Reference

#include <popup.h>

Data Fields
SDL_Surface *	surface
int	bitmap_id
SDL_Surface *	overlay
void *	custom_data
char *	buf
sint64	i [3]
int	x
int	y
void(*	draw_func )(struct popup_struct *popup)
void(*	draw_func_post )(struct popup_struct *popup)
int(*	event_func )(struct popup_struct *popup, SDL_Event *event)
int(*	destroy_callback_func )(struct popup_struct *popup)

---

Detailed Description

A single popup.

Definition at line 34 of file popup.h.

---

Field Documentation

int popup_struct::bitmap_id

Bitmap ID to blit on the surface.

Definition at line 42 of file popup.h.

char* popup_struct::buf

Optional character pointer.

Definition at line 53 of file popup.h.

void* popup_struct::custom_data

Custom data.

Definition at line 50 of file popup.h.

int(* popup_struct::destroy_callback_func)(struct popup_struct *popup)

Function used right before the visible popup is destroyed using popup_destroy_visible().

Parameters:

popup

The popup.

Returns:

1 to proceed with the destruction of the popup, 0 otherwise.

Definition at line 90 of file popup.h.

void(* popup_struct::draw_func)(struct popup_struct *popup)

Function used for drawing on the popup's surface.

Parameters:

popup

The popup.

Definition at line 67 of file popup.h.

void(* popup_struct::draw_func_post)(struct popup_struct *popup)

Function used for drawing after blitting the popup's surface on the main surface.

Parameters:

popup

The popup..

Definition at line 73 of file popup.h.

int(* popup_struct::event_func)(struct popup_struct *popup, SDL_Event *event)

Function used for handling mouse/key events when popup is visible.

Parameters:

event

SDL event.

Return values:

-1	Did not handle the event.
0	Did not handle the event, but allow other keyboard events.
1	Handled the event.

Definition at line 82 of file popup.h.

sint64 popup_struct::i[3]

Optional integers.

Definition at line 56 of file popup.h.

SDL_Surface* popup_struct::overlay

Overlay image to draw before popup_struct::surface over the ScreenSurface.

Definition at line 47 of file popup.h.

SDL_Surface* popup_struct::surface

Surface the popup uses for blitting. This surface is then copied to ScreenSurface.

Definition at line 39 of file popup.h.

int popup_struct::x

X position of the popup.

Definition at line 59 of file popup.h.

int popup_struct::y

Y position of the popup.

Definition at line 62 of file popup.h.

---

The documentation for this struct was generated from the following file:

• include/popup.h