SUNENGINE/html/_u_i_command_8h_source.html

#ifndef UICommand_H

#define UICommand_H


#include "../CommandBase.h"

#include "UIComponent.h"

#include "UIAttorney.h"


class UICommand : public CommandBase

{

public:

    void Execute() override = 0;


    virtual ~UICommand() override = default;


    void SetUIComponent(UIComponent* p, UIComponentType t);


    UIComponent* GetUIComponent() const;


    UIComponentType GetType() const;


private:

    friend class UIAttorney::GameLoop;

    UIComponentType Type = UIComponentType::None;

    UIComponent* pUIComponent = nullptr;

};


#endif

CommandBase.h
Defines the base class for all command objects.

CommandBase
Base class for all command objects.
Definition CommandBase.h:19

UIAttorney::GameLoop
Attorney for game loop access to UIComponent methods.
Definition UIAttorney.h:34

UICommand
Abstract base class for UI-related command objects.
Definition UICommand.h:32

UICommand::GetUIComponent
UIComponent * GetUIComponent() const
Gets the associated UIComponent.
Definition UICommand.cpp:9

UICommand::GetType
UIComponentType GetType() const
Gets the type of the associated UIComponent.
Definition UICommand.cpp:14

UICommand::Execute
void Execute() override=0
Pure virtual method to execute the command. Must be implemented by derived classes.

UICommand::SetUIComponent
void SetUIComponent(UIComponent *p, UIComponentType t)
Associates this command with a UIComponent and its type.
Definition UICommand.cpp:3

UICommand::pUIComponent
UIComponent * pUIComponent
Pointer to the associated UIComponent.
Definition UICommand.h:67

UICommand::Type
UIComponentType Type
Type of the associated UIComponent.
Definition UICommand.h:66

UICommand::~UICommand
virtual ~UICommand() override=default
Virtual destructor.

UIComponent
Abstract base class for all UI components.
Definition UIComponent.h:32