AG_Button * AG_ButtonNew (AG_Widget *parent, Uint flags, const char *format, ...)
AG_Button * AG_ButtonNewS (AG_Widget *parent, Uint flags, const char *label)
AG_Button * AG_ButtonNewFn (AG_Widget *parent, Uint flags, const char *label, void (*fn)(AG_Event *), const char *fnArgs, ...)
AG_Button * AG_ButtonNewInt (AG_Widget *parent, Uint flags, const char *label, int *p)
AG_Button * AG_ButtonNewUint (AG_Widget *parent, Uint flags, const char *label, Uint *p)
AG_Button * AG_ButtonNewFlag (AG_Widget *parent, Uint flags, const char *label, Uint *p, Uint bitmask)
void AG_ButtonSetInverted (AG_Button *button, int enable)
void AG_ButtonSetFocusable (AG_Button *button, int enable)
void AG_ButtonSetSticky (AG_Button *button, int enable)
void AG_ButtonJustify (AG_Button *button, enum ag_text_justify justify)
void AG_ButtonValign (AG_Button *button, enum ag_text_valign valign)
void AG_ButtonSetRepeatMode (AG_Button *button, int enable)
void AG_ButtonSurface (AG_Button *button, const AG_Surface *su)
void AG_ButtonSurfaceNODUP (AG_Button *button, AG_Surface *su)
void AG_ButtonText (AG_Button *button, const char *format, ...)
void AG_ButtonTextS (AG_Button *button, const char *label)
int AG_ButtonGetState (AG_Button *button)
int AG_ButtonSetState (AG_Button *button, int stateNew)
int AG_ButtonToggle (AG_Button *button)
|
The
AG_ButtonNew() function allocates, initializes, and attaches an
AG_Button. If
label is non-NULL, it sets the initial text label.
For a list of acceptable option
flags refer to
BUTTON FLAGS below.
The
AG_ButtonNewFn() variant creates a button and also specifies a callback routine to run
whenever it is pressed.
Contrary to
AG_ButtonNew(), it implies
AG_BUTTON_EXCL (unless
AG_BUTTON_NOEXCL is passed).
The
AG_ButtonNewInt() shorthand creates a button and also sets its
state binding to the natural integer at memory location
p.
The
AG_ButtonNewFlag() shorthand creates a button and also sets its
state binding to the value of the bit(s) indicated by
bitmask contained within the natural integer at memory location
p.
AG_ButtonSetInverted() inverts the interpretation of the "state" binding
(sets the
AG_BUTTON_INVERTED flag).
AG_ButtonSetFocusable() sets whether the button is allowed to receive focus (0 = No, 1 = Yes).
Default is Yes (see
AG_WidgetFocus(3)).
AG_ButtonSetSticky() sets the behavior of the button when pressed (0 = Momentary, 1 = Sticky).
In Momentary mode, the button springs back to its former state when released.
Default is Sticky.
AG_ButtonJustify() sets the justification mode for the text label.
The
justify argument can be
AG_TEXT_LEFT, AG_TEXT_CENTER or
AG_TEXT_RIGHT.
AG_ButtonValign() sets the vertical alignment for the text label.
The
valign argument can be
AG_TEXT_TOP, AG_TEXT_MIDDLE or
AG_TEXT_BOTTOM.
AG_ButtonSetRepeatMode() enables or disables Repeat mode.
Repeat mode causes multiple
button-pushed events to be posted periodically for as long as the button is triggered
(with an interval of
agMouseSpinIval ms).
AG_ButtonSurface() sets the button label to a copy of the given surface.
AG_ButtonSurfaceNODUP() uses the given surface as source without copying (potentially unsafely).
If a label is currently set, it is replaced.
AG_ButtonText() sets the label of the button from the specified text string.
If a surface is currently set, it is removed.
AG_ButtonGetState() returns the current boolean state of the button (1 = pressed, 0 = released).
AG_ButtonSetState() sets the state to
stateNew and returns the previous state.
AG_ButtonToggle() atomically toggles the state of the button and returns the new state.
|