.\" Copyright (c) 2008 Hypertriton, Inc. <http://hypertriton.com/>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
.\" (INCLUDING BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
.\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd October 17, 2008
.Dt AG_TITLEBER 3
.Os
.ds vT Agar API Reference
.ds oS Agar 1.3.3
.Sh NAME
.Nm AG_Titlebar
.Nd agar stock titlebar widget
.Sh SYNOPSIS
.Bd -literal
#include <agar/core.h>
#include <agar/gui.h>
.Ed
.Sh DESCRIPTION
The
.Nm
widget is Agar's general-purpose window titlebar.
It is derived from
.Xr AG_Box 3 ,
it packs an
.Xr AG_Label 3
and optional
.Xr AG_Button 3
controls for closing, minimizing and maximizing the window.
.Sh INHERITANCE HIERARCHY
.Xr AG_Object 3 ->
.Xr AG_Widget 3 ->
.Xr AG_Box 3 ->
.Nm .
.Sh INITIALIZATION
Note: Unless the
.Dv AG_WINDOW_NOTITLE
is used, a
.Nm
is attached by default to newly created windows (see
.Xr AG_Window 3 ) .
This interface is therefore rarely used directly.
.Pp
.nr nS 1
.Ft "AG_Titlebar *"
.Fn AG_TitlebarNew "AG_Widget *parent" "Uint flags"
.Pp
.nr nS 0
The
.Fn AG_TitlebarNew
function allocates, initializes, and attaches a new
.Nm
widget.
Available
.Fa flags
options include:
.Pp
.Bl -tag -compact -width "AG_TITLEBAR_NO_MAXIMIZE "
.It AG_TITLEBAR_NO_CLOSE
Disable the
.Em close
control button.
.It AG_TITLEBAR_NO_MINIMIZE
Disable the
.Em minimize
control button.
.It AG_TITLEBAR_NO_MAXIMIZE
Disable the
.Em maximize
control button.
.El
.Sh EVENTS
The
.Nm
widget generates the following events:
.Pp
.Bl -tag -compact -width 2n
.It Fn window-close "void"
The
.Em close
button has been triggered.
.El
.Sh STRUCTURE DATA
For the
.Ft AG_Titlebar
object:
.Pp
.Bl -tag -compact -width "AG_Label *label "
.It Ft AG_Window *win
Back pointer to the attached
.Xr AG_Window 3 ,
if any.
.It Ft AG_Label *label
Pointer to the
.Xr AG_Label 3
displaying the window caption.
.El
.Sh SEE ALSO
.Xr AG_Intro 3 ,
.Xr AG_Button 3 ,
.Xr AG_Label 3 ,
.Xr AG_View 3 ,
.Xr AG_Widget 3 ,
.Xr AG_Window 3
.Sh HISTORY
The
.Nm
widget first appeared in Agar 1.0.