NAME

AG_Separator — agar cosmetic separator widget

SYNOPSIS

#include <agar/core.h>
#include <agar/gui.h>

DESCRIPTION

The AG_Separator widget draws a horizontal or vertical line or spacer.

INHERITANCE HIERARCHY

AG_Object(3) -> AG_Widget(3) -> AG_Separator.

INITIALIZATION

AG_Separator *
AG_SeparatorNew(AG_Widget *parent, enum ag_separator_type type);

AG_Separator *
AG_SpacerNew(AG_Widget *parent, enum ag_separator_type type);

AG_Separator *
AG_SeparatorNewHoriz(AG_Widget *parent);

AG_Separator *
AG_SeparatorNewVert(AG_Widget *parent);

AG_Separator *
AG_SpacerNewHoriz(AG_Widget *parent);

AG_Separator *
AG_SpacerNewVert(AG_Widget *parent);

void
AG_SeparatorSetLength(AG_Separator *sep, Uint pixels);

The AG_SeparatorNew() function creates a new separator that displays a visible line. AG_SpacerNew() creates a new separator that does not draw a visible line. type is one of:

enum ag_separator_type {
	AG_SEPARATOR_HORIZ,
	AG_SEPARATOR_VERT
};

The AG_SeparatorNewHoriz(), AG_SeparatorNewVert(), AG_SpacerNewHoriz() and AG_SpacerNewVert() variants do not take a type argument.

By default, AG_Separator expands to fit available space in parent container. AG_SeparatorSetLength() requests a minimum length in pixels.

EVENTS

The AG_Separator widget does not generate any event.

SEE ALSO

AG_Intro(3), AG_Widget(3), AG_Window(3)

HISTORY

The AG_Separator widget first appeared in Agar 1.0. In Agar 1.6.0, AG_SeparatorSetLength() was added and AG_SeparatorSetPadding() was deprecated by the generic "padding" style attribute.