Gorgon Game Engine
Base Class Referenceabstract

Provides the basis for the automatic UI organizers. More...

Inheritance diagram for Base:
[legend]

Public Member Functions

virtual ~Base ()
 Ensuring correct destruction. More...
 
void AttachTo (WidgetContainer &container)
 Attaches this organizer to a container. More...
 
WidgetContainerGetAttached () const
 Returns the container that this organizer is attached to. More...
 
bool IsAttached () const
 Returns if this organizer is attached to a container. More...
 
void RemoveFrom ()
 Removes the organizer from the container. More...
 
void Reorganize ()
 Reorganizes the widgets that are organized by this organizer. More...
 

Protected Member Functions

virtual void attachmentchanged ()
 Called when the attachment of the organizer is changed. More...
 
virtual void reorganize ()=0
 Should reorganize the contents of the organizer. More...
 

Detailed Description

Provides the basis for the automatic UI organizers.

Constructor & Destructor Documentation

◆ ~Base()

virtual ~Base ( )
virtual

Ensuring correct destruction.

Member Function Documentation

◆ attachmentchanged()

virtual void attachmentchanged ( )
protectedvirtual

Called when the attachment of the organizer is changed.

◆ AttachTo()

void AttachTo ( WidgetContainer container)

Attaches this organizer to a container.

References Base::attachmentchanged(), and WidgetContainer::AttachOrganizer().

◆ GetAttached()

WidgetContainer& GetAttached ( ) const

Returns the container that this organizer is attached to.

If organizer is not attached, this function will throw.

◆ IsAttached()

bool IsAttached ( ) const

Returns if this organizer is attached to a container.

◆ RemoveFrom()

void RemoveFrom ( )

Removes the organizer from the container.

References Base::attachmentchanged(), and WidgetContainer::RemoveOrganizer().

◆ Reorganize()

void Reorganize ( )

Reorganizes the widgets that are organized by this organizer.

References Base::IsAttached(), and Base::reorganize().

◆ reorganize()

virtual void reorganize ( )
protectedpure virtual

Should reorganize the contents of the organizer.

This will only be called if the organizer is attached.

Implemented in List.


The documentation for this class was generated from the following files: