Unit 'mui' Package
[Overview][Constants][Types][Procedures and functions][Variables][Index] [#aros]

MUIC_Family

Family class is the base class for objects that are able to handle a list of children.

Declaration

Source position: mui.pas line 782

const MUIC_Family: PChar = 'Family.mui';

Description

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.

Inheritance
rootclass --> Notify --> Family

Fields
_______________ Field _______________ ___ Access ___ _____ Type _____ Short description
MUIA_Family_Child I__ PObject_ Add a child to family child list on creation
MUIA_Family_List I__ PMinList Returns a pointer to a struct MinList which contains the children of a family object.
Fields inherited from Notify
_______________ Field _______________ ___ Access ___ _____ Type _____ Short description
MUIA_ApplicationObject __G PObject_ Obtain a pointer to the application object that some gadget belongs
MUIA_AppMessage __G PAppMessage Listen to this field to get AppMessages (Icon dropped on the App window)
MUIA_HelpLine ISG LongInt Define a line in a help file specified with MUIA_Application_HelpFile
MUIA_HelpNode ISG PChar Define a node in a help file specified with MUIA_Application_HelpFile
MUIA_NoNotify _S_ BOOL (0/1) Prevent notification from being triggered on attribute set
MUIA_ObjectID ISG LongWord Identification for object on save/load
MUIA_Parent __G PObject_ Get a pointer to the parent object of the current object
MUIA_Revision __G LongInt Get the revision number of an objects class
MUIA_UserData ISG LongWord A general purpose value to fill in any kind of information
MUIA_Version __G LongInt Get the version number of an objects class

Methods
_______________ Method _______________ Short description
MUIM_Family_AddHead Add an object as first object to the family.
MUIM_Family_AddTail Add an object as last object to the family.
MUIM_Family_Insert Add an object after another object to the family.
MUIM_Family_Remove Remove an object from a family.
MUIM_Family_Sort Sort the children of a family.
Methods inherited from Notify
_______________ Method _______________ Short description
MUIM_CallHook Call a standard amiga callback hook
MUIM_Export Called on export object to dataspace
MUIM_FindUData Find a userdata in objects and childrens list and return the object
MUIM_GetConfigItem
MUIM_GetUData Find a userdata in objects and childrens list and return an attribute of the object
MUIM_Import Called on import object from dataspace
MUIM_KillNotify Kills previously given notifications on specific attributes
MUIM_KillNotifyObj
MUIM_MultiSet Set an attribute for multiple objects.
MUIM_NoNotifySet Acts like MUIM_Notify but doesn't trigger any notification
MUIM_Notify Add a notification event handler to an object
MUIM_Set Set an attribute to a value
MUIM_SetAsString Set a (text kind) attribute to a string.
MUIM_SetUData Find a userdata in objects and childrens list and set an attribute of the object
MUIM_SetUDataOnce This method performs like MUIM_SetUData, but stop at first found object.
MUIM_WriteLong This method simply writes a longword somewhere to memory.
MUIM_WriteString This method simply copies a string somewhere to memory.
MUIM_ConnectParent (AROS only)
MUIM_DisconnectParent (AROS only)

Documentation generated on: 2021-07-30