Poison-ui

A cross-platform desktop/mobile UI engine written in D using dsfml

View project on GitHub

Dub version

poison.ui.container

Source

Module for a container.

Authors:

  Jacob Jensen

License:

  https://github.com/PoisonEngine/poison-ui/blob/master/LICENSE

Imports

std.algorithm : filter

std.array : array

public dsfml.graphics : RenderWindow

poison.ui.component

poison.core : Size, Point, ActionArgs, executeUI

public:

class Container : Component
        this(string name, Size initialSize, size_t layers);
        this(string name, size_t layers);
        @property override bool disabled();
        @property override void disabled(bool isDisabled);
        void add(Component child, size_t layer);
        void add(Component[] components, size_t layer);
        void remove(Component child);
        void remove(string name);
        void clear();
        void clear(size_t layer);

        protected:

        override void process(RenderWindow window);


public class Container : Component

        public:

        this(string name, Size initialSize, size_t layers);
        this(string name, size_t layers);
        @property override bool disabled();
        @property override void disabled(bool isDisabled);
        void add(Component child, size_t layer);
        void add(Component[] components, size_t layer);
        void remove(Component child);
        void remove(string name);
        void clear();
        void clear(size_t layer);

        protected:

        override void process(RenderWindow window);


A container component.


public this(string name, Size initialSize, size_t layers);

Creates a new container.

Parameters:

nameThe name of the container.
initialSizeThe initial size of the container.
layersThe layers of the container.

public this(string name, size_t layers);

Creates a new container.

Parameters:

nameThe name of the container.
layersThe layers of the container.

public @property override bool disabled();

Gets a boolean determining whether the container is disabled or not.


public @property override void disabled(bool isDisabled);

Sets a boolean determining whether the container is disabled or not.


public void add(Component child, size_t layer);

Adds a component to the container.

Parameters:

childThe child component to add.
layerThe layer to add the component to.

public void add(Component[] components, size_t layer);

Adds an array of components to the container.

Parameters:

componentsThe child components to add.
layerThe layer to add the components to.

public void remove(Component child);

Removes a component from the container.

Parameters:

childThe child component to remove.

public void remove(string name);

Removes a component from the container.

Parameters:

nameThe name of the component.

public void clear();

Clears the component for children.


public void clear(size_t layer);

Clears the components for a specific layer.

Parameters:

layerThe layer to clear.

protected override void process(RenderWindow window);

Processes the container during application cycles.

Parameters:

windowThe render window to process.

Generated by venom - Poison Engine's Documentation Generator