%---------------- Functions ------------

\chapter{Family.mui/Family.mui}
\rule{\textwidth}{1mm}
\vspace{0.5cm}
\begin{deflist}{MMMMMMMM}
\item[\bf FUNCTION]
Family class is the base class for objects that are able
to handle a list of children. This is e.g. the case for
MUIs Menustrip, Menu and Menuitem objects.

Family class defines methods and attributes to
add and remove children, sort children, and transfer
children to other Family objects.

Group class and application class should also be a
subclass of Family class, but due to BOOPSI system
limitations, this is currently impossible. If the
future will allow more logical class trees, things
might change, but everything will be done in a
compatible manner.
\end{deflist}


\subsection{Family.mui/MUIA\_Family\_Child}
\rule{\textwidth}{1mm}
\vspace{0.5cm}
\begin{deflist}{MMMMMMMM}
\item[\bf NAME]
\begin{description}
\item[MUIA\_Family\_Child]  -- (V8 ) [I..], Object *
\end{description}

\item[\bf FUNCTION]
You supply a pointer to a previously created MUI object
here. This object will be added to family at family
creation time.

Of course you can specify any number of child objects,
limited only by available memory.

Normally, the value for a MUIA\_Family\_Child tag is
a direct call to another MUI\_NewObject(), children
are generated "'on the fly"'.

When a family is disposed, all of its children will also
get deleted. If you supply a NULL pointer as child,
the family object will fail and previously dispose all
valid children found in the taglist.

This behaviour makes it possible to generate a complete
family within one single (but long) MUI\_NewObject()
call. Error checking is not necessary since every error,
even if it occurs in a very deep nesting level, will
cause the complete call to fail without leaving back
any previously created object.

\item[\bf NOTES]
As a special case, MUIA\_Group\_Child is also recognized
and treated as MUIA\_Family\_Child.

\item[\bf SEE ALSO]
MUIM\_Family\_AddTail, MUIM\_Family\_Insert,
MUIM\_Family\_AddHead, MUIA\_Family\_Remove
\end{deflist}


\subsection{Family.mui/MUIA\_Family\_List}
\rule{\textwidth}{1mm}
\vspace{0.5cm}
\begin{deflist}{MMMMMMMM}
\item[\bf NAME]
\begin{description}
\item[MUIA\_Family\_List]  -- (V8 ) [..G], struct MinList *
\end{description}

\item[\bf FUNCTION]
Returns a pointer to a struct MinList which contains the children
of a family object. You must parse this list with
intuition.library/NextObject().

\item[\bf SEE ALSO]
MUIA\_Family\_Child
\end{deflist}


\subsection{Family.mui/MUIM\_Family\_AddHead}
\rule{\textwidth}{1mm}
\vspace{0.5cm}
\begin{deflist}{MMMMMMMM}
\item[\bf NAME]
MUIM\_Family\_AddHead (V8 )

\item[\bf SYNOPSIS]
\begin{flushleft}
\begin{verbatim}
DoMethod(obj,MUIM_Family_AddHead,Object *obj);
\end{verbatim}
\end{flushleft}
\item[\bf FUNCTION]
Add an object as first object to the family.
Subclasses of family class usually define which
types of objects are possible within their family.

\item[\bf INPUTS]
\begin{description}
\item[obj]  - the object to be added.
\end{description}

\item[\bf SEE ALSO]
MUIM\_Family\_AddTail, MUIM\_Family\_Insert,
MUIM\_Family\_Remove, MUIA\_Family\_Child
\end{deflist}


\subsection{Family.mui/MUIM\_Family\_AddTail}
\rule{\textwidth}{1mm}
\vspace{0.5cm}
\begin{deflist}{MMMMMMMM}
\item[\bf NAME]
MUIM\_Family\_AddTail (V8 )

\item[\bf SYNOPSIS]
\begin{flushleft}
\begin{verbatim}
DoMethod(obj,MUIM_Family_AddTail,Object *obj);
\end{verbatim}
\end{flushleft}
\item[\bf FUNCTION]
Add an object as last object to the family.
Subclasses of family class usually define which
types of objects are possible within their family.

This method does the same as OM\_ADDMEMBER.

\item[\bf INPUTS]
\begin{description}
\item[obj]  - the object to be added.
\end{description}

\item[\bf SEE ALSO]
MUIM\_Family\_AddHead, MUIM\_Family\_Insert,
MUIM\_Family\_Remove, MUIA\_Family\_Child
\end{deflist}


\subsection{Family.mui/MUIM\_Family\_Insert}
\rule{\textwidth}{1mm}
\vspace{0.5cm}
\begin{deflist}{MMMMMMMM}
\item[\bf NAME]
MUIM\_Family\_Insert (V8 )

\item[\bf SYNOPSIS]
\begin{flushleft}
\begin{verbatim}
DoMethod(obj,MUIM_Family_Insert,Object *obj, Object *pred);
\end{verbatim}
\end{flushleft}
\item[\bf FUNCTION]
Add an object after another object to the family.
Subclasses of family class usually define which
types of objects are possible within their family.

\item[\bf INPUTS]
obj  - the object to be added.
\begin{description}
\item[pred]  - the new object is inserted *after* this
       object. pred must of course be a member
       of the family.
\end{description}

\item[\bf SEE ALSO]
MUIM\_Family\_AddTail, MUIM\_Family\_AddHead,
MUIM\_Family\_Remove, MUIA\_Family\_Child
\end{deflist}


\subsection{Family.mui/MUIM\_Family\_Remove}
\rule{\textwidth}{1mm}
\vspace{0.5cm}
\begin{deflist}{MMMMMMMM}
\item[\bf NAME]
MUIM\_Family\_Remove (V8 )

\item[\bf SYNOPSIS]
\begin{flushleft}
\begin{verbatim}
DoMethod(obj,MUIM_Family_Remove,Object *obj);
\end{verbatim}
\end{flushleft}
\item[\bf FUNCTION]
Remove an object from a family.

This method does the same as OM\_REMMEMBER.

\item[\bf INPUTS]
\begin{description}
\item[obj]  - the object to be removed.
\end{description}

\item[\bf SEE ALSO]
MUIM\_Family\_AddTail, MUIM\_Family\_Insert,
MUIM\_Family\_AddHead, MUIA\_Family\_Child
\end{deflist}


\subsection{Family.mui/MUIM\_Family\_Sort}
\rule{\textwidth}{1mm}
\vspace{0.5cm}
\begin{deflist}{MMMMMMMM}
\item[\bf NAME]
MUIM\_Family\_Sort (V8 )

\item[\bf SYNOPSIS]
\begin{flushleft}
\begin{verbatim}
DoMethod(obj,MUIM_Family_Sort,Object *obj[1]);
\end{verbatim}
\end{flushleft}
\item[\bf FUNCTION]
Sort the children of a family.

\item[\bf INPUTS]
\begin{description}
\item[child]  - array that contains *all* the children of the
        family in the desired order. The array must be
        terminated with a NULL entry.
\end{description}

\item[\bf SEE ALSO]
MUIA\_Family\_Child
\end{deflist}


\subsection{Family.mui/MUIM\_Family\_Transfer}
\rule{\textwidth}{1mm}
\vspace{0.5cm}
\begin{deflist}{MMMMMMMM}
\item[\bf NAME]
MUIM\_Family\_Transfer (V8 )

\item[\bf SYNOPSIS]
\begin{flushleft}
\begin{verbatim}
DoMethod(obj,MUIM_Family_Transfer,Object *family);
\end{verbatim}
\end{flushleft}
\item[\bf FUNCTION]
All the children of the family are removed and
added to another family in the same order.

\item[\bf INPUTS]
\begin{description}
\item[family]  - the destination family.
\end{description}

\item[\bf SEE ALSO]
MUIA\_Family\_Child
\end{deflist}


%---------------- End of File ----------