ui_node_panel.h

Go to the documentation of this file.

/*
Copyright (C) 2002-2020 UFO: Alien Invasion.

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

*/

#pragma once

#include "ui_node_abstractscrollable.h"

class uiPanelNode : public uiAbstractScrollableNode {
    void draw(uiNode_t* node) override;
    void onLoaded(uiNode_t* node) override;
    void onLoading(uiNode_t* node) override;
    void doLayout(uiNode_t* node) override;
    void getClientPosition(uiNode_t const* node, vec2_t position) override;
    void onPropertyChanged(uiNode_t* node, const value_t* property) override;
    bool onScroll(uiNode_t* node, int deltaX, int deltaY) override;
    void onMouseUp(uiNode_t* node, int x, int y, int button) override;
    bool onMouseLongPress(uiNode_t* node, int x, int y, int button) override;
    bool onStartDragging(uiNode_t* node, int startX, int startY, int currentX, int currentY, int button) override;
    void onCapturedMouseMove(uiNode_t* node, int x, int y) override;
};

struct uiBehaviour_t;

typedef enum {
    LAYOUT_NONE,
    LAYOUT_TOP_DOWN_FLOW,
    LAYOUT_LEFT_RIGHT_FLOW,
    LAYOUT_BORDER,
    LAYOUT_PACK,
    LAYOUT_STAR,
    LAYOUT_CLIENT,
    LAYOUT_COLUMN,

    LAYOUT_MAX,
    LAYOUT_ENSURE_32BIT = 0x7FFFFFFF
} panelLayout_t;

typedef enum {
    LAYOUTALIGN_NONE = 0,

    /* vertical and horizontal flag bits */
    LAYOUTALIGN_H_MASK    = 0x03,
    LAYOUTALIGN_H_LEFT    = 0x01,
    LAYOUTALIGN_H_MIDDLE  = 0x02,
    LAYOUTALIGN_H_RIGHT   = 0x03,
    LAYOUTALIGN_V_MASK    = 0x0C,
    LAYOUTALIGN_V_TOP     = 0x04,
    LAYOUTALIGN_V_MIDDLE  = 0x08,
    LAYOUTALIGN_V_BOTTOM  = 0x0C,

    /* common alignment */
    LAYOUTALIGN_TOPLEFT     = (LAYOUTALIGN_V_TOP | LAYOUTALIGN_H_LEFT),
    LAYOUTALIGN_TOP         = (LAYOUTALIGN_V_TOP | LAYOUTALIGN_H_MIDDLE),
    LAYOUTALIGN_TOPRIGHT    = (LAYOUTALIGN_V_TOP | LAYOUTALIGN_H_RIGHT),
    LAYOUTALIGN_LEFT        = (LAYOUTALIGN_V_MIDDLE | LAYOUTALIGN_H_LEFT),
    LAYOUTALIGN_MIDDLE      = (LAYOUTALIGN_V_MIDDLE | LAYOUTALIGN_H_MIDDLE),
    LAYOUTALIGN_RIGHT       = (LAYOUTALIGN_V_MIDDLE | LAYOUTALIGN_H_RIGHT),
    LAYOUTALIGN_BOTTOMLEFT  = (LAYOUTALIGN_V_BOTTOM | LAYOUTALIGN_H_LEFT),
    LAYOUTALIGN_BOTTOM      = (LAYOUTALIGN_V_BOTTOM | LAYOUTALIGN_H_MIDDLE),
    LAYOUTALIGN_BOTTOMRIGHT = (LAYOUTALIGN_V_BOTTOM | LAYOUTALIGN_H_RIGHT),

    /* special align, everything bigger 0x10 */
    LAYOUTALIGN_SPECIAL     = 0x10,

    /* pack and star layout manager only */
    LAYOUTALIGN_FILL,

    LAYOUTALIGN_MAX,
    LAYOUTALIGN_ENSURE_32BIT = 0x7FFFFFFF
} layoutAlign_t;

#define UI_GET_VERTICAL_ALIGN(align) ((align >= LAYOUTALIGN_SPECIAL)?LAYOUTALIGN_NONE:(LAYOUTALIGN_V_MASK & align))

#define UI_GET_HORIZONTAL_ALIGN(align) ((align >= LAYOUTALIGN_SPECIAL)?LAYOUTALIGN_NONE:(LAYOUTALIGN_H_MASK & align))

typedef struct {
    abstractScrollableExtraData_t super;
    panelLayout_t layout;       
    int layoutMargin;           
    int layoutColumns;          
    bool wheelScrollable;   
    uiSprite_t* background;
} panelExtraData_t;

void UI_Panel_SetBackgroundByName(uiNode_t* node, const char* name);

void UI_RegisterPanelNode(uiBehaviour_t* behaviour);
void UI_StarLayout(uiNode_t* node);