ScummVM API documentation
QDEngine::qdInterfaceButton Class Reference

Интерфейсный элемент - кнопка. More...

#include <qd_interface_button.h>

Inheritance diagram for QDEngine::qdInterfaceButton:
QDEngine::qdInterfaceElement QDEngine::qdInterfaceObjectBase QDEngine::qdNamedObjectBase

Public Member Functions

 qdInterfaceButton (const qdInterfaceButton &bt)
 
qdInterfaceButtonoperator= (const qdInterfaceButton &bt)
 
qdInterfaceElement::element_type get_element_type () const
 Возвращает тип элемента.
 
int num_states () const
 Возвращает количество состояний кнопки.
 
bool activate_state (int state_num)
 Включает состояние номер state_num.
 
bool activate_state (const char *state_name)
 Включает состояние с именем state_name.
 
int option_value () const
 Возвращает значение настройки игры, связанной с элементом.
 
bool set_option_value (int value)
 Устанавливает значение настройки игры, связанной с элементом.
 
const qdInterfaceElementStateget_state (int state_num) const
 Возвращает указатель на состояние кнопки.
 
qdInterfaceElementStateget_state (int state_num)
 Возвращает указатель на состояние кнопки.
 
bool add_state (const qdInterfaceElementState &st)
 Добавляет состояние кнопки. More...
 
bool insert_state (int insert_before, const qdInterfaceElementState &st)
 Добавляет состояние кнопки. More...
 
bool erase_state (int state_num)
 Удаляет состояние номер state_num.
 
bool modify_state (int state_num, const qdInterfaceElementState &st)
 Модифицирует состояние кнопки. More...
 
bool change_state (bool direction=true)
 Переключает состояние кнопки. More...
 
bool mouse_handler (int x, int y, mouseDispatcher::mouseEvent ev)
 Обработчик событий мыши.
 
bool keyboard_handler (Common::KeyCode vkey)
 Обработчик ввода с клавиатуры.
 
bool init (bool is_game_active=true)
 Инициализация элемента. More...
 
bool quant (float dt)
 Обсчет логики, параметр - время в секундах.
 
bool hit_test (int x, int y) const
 Возвращает true, если точка с экранными координатами (x,у) попадает в элемент.
 
const qdInterfaceEventfind_event (qdInterfaceEvent::event_t type) const
 
bool has_event (qdInterfaceEvent::event_t type, const char *ev_data=NULL) const
 
- Public Member Functions inherited from QDEngine::qdInterfaceElement
 qdInterfaceElement (const qdInterfaceElement &el)
 
qdInterfaceElementoperator= (const qdInterfaceElement &el)
 
option_ID_t option_ID () const
 Возвращает идентификатор настройки игры, связанной с элементом.
 
void set_option_ID (option_ID_t id)
 Устанавливает идентификатор настройки игры, связанной с элементом.
 
bool linked_to_option () const
 Возвращает true, если с элементом связана настройка игры.
 
virtual const Vect2i r () const
 Возвращает экранные координаты центра элемента.
 
void set_r (const Vect2i &v)
 Устанавливает экранные координаты центра элемента.
 
virtual int size_x () const
 Возвращает размер элемента по горизонтали в пикселах.
 
virtual int size_y () const
 Возвращает размер элемента по вертикали в пикселах.
 
virtual grScreenRegion screen_region () const
 
const grScreenRegionlast_screen_region () const
 
void set_screen_depth (int v)
 Устанавливает экранную глубину элемента.
 
int screen_depth () const
 Возвращает экранную глубину эелмента.
 
bool save_script (Common::WriteStream &fh, int indent=0) const
 Запись данных в скрипт.
 
bool load_script (const xml::tag *p)
 Загрузка данных из скрипта.
 
virtual bool redraw () const
 Отрисовка элемента.
 
virtual bool need_redraw () const
 
virtual bool post_redraw ()
 
virtual bool char_input_handler (int vkey)
 Обработчик ввода символов с клавиатуры.
 
virtual void hover_clear ()
 
const qdAnimationanimation () const
 
bool set_animation (const qdAnimation *anm, int anm_flags=0)
 Устанавливает анимацию для элемента.
 
bool set_state (const qdInterfaceElementState *p)
 Включает состояние элемента.
 
qdResourceadd_resource (const Common::Path file_name, const qdInterfaceElementState *res_owner)
 Добавляет ресурс file_name с владельцем owner.
 
bool remove_resource (const Common::Path file_name, const qdInterfaceElementState *res_owner)
 Удаляет ресурс file_name с владельцем owner.
 
state_status_t state_status (const qdInterfaceElementState *p) const
 Возвращает статус состояния.
 
void hide ()
 Прячет элемент.
 
void show ()
 Показывает элемент.
 
bool is_visible () const
 Возвращает true, если элемент не спрятан.
 
bool is_locked () const
 Возвращает true, если элемент заблокирован.
 
void set_lock (bool state)
 Блокировка/разблокировка элемента.
 
- Public Member Functions inherited from QDEngine::qdInterfaceObjectBase
 qdInterfaceObjectBase (const qdInterfaceObjectBase &obj)
 
void set_owner (qdInterfaceObjectBase *p)
 Устанавливает владельца объекта.
 
qdInterfaceObjectBaseowner () const
 Возвращает указатель на владельца объекта.
 
- Public Member Functions inherited from QDEngine::qdNamedObjectBase
 qdNamedObjectBase (const qdNamedObjectBase &obj)
 
qdNamedObjectBaseoperator= (const qdNamedObjectBase &obj)
 
const char * name () const
 Возвращает имя объекта.
 
void set_name (const char *p)
 Устанавливает имя объекта.
 

Protected Member Functions

bool save_script_body (Common::WriteStream &fh, int indent=0) const
 Запись данных в скрипт.
 
bool load_script_body (const xml::tag *p)
 Загрузка данных из скрипта.
 
- Protected Member Functions inherited from QDEngine::qdInterfaceElement
void clear_screen_region ()
 
- Protected Member Functions inherited from QDEngine::qdInterfaceObjectBase
qdInterfaceObjectBaseoperator= (const qdInterfaceObjectBase &obj)
 

Additional Inherited Members

- Public Types inherited from QDEngine::qdInterfaceElement
enum  option_ID_t {
  OPTION_NONE = 0, OPTION_SOUND, OPTION_SOUND_VOLUME, OPTION_MUSIC,
  OPTION_MUSIC_VOLUME, OPTION_ACTIVE_PERSONAGE
}
 Идентификаторы настроек игры. More...
 
enum  element_type {
  EL_BACKGROUND, EL_BUTTON, EL_SLIDER, EL_SAVE,
  EL_TEXT_WINDOW, EL_COUNTER
}
 Типы элементов интерфейса. More...
 
enum  state_status_t { STATE_INACTIVE, STATE_ACTIVE, STATE_DONE }
 Статус состояния. More...
 
- Static Public Member Functions inherited from QDEngine::qdInterfaceElement
static qdInterfaceElementcreate_element (element_type tp)
 Создание элемента интерфейса заданного типа.
 
static void destroy_element (qdInterfaceElement *p)
 Уничтожение элемента интерфейса.
 

Detailed Description

Интерфейсный элемент - кнопка.

Member Function Documentation

◆ add_state()

bool QDEngine::qdInterfaceButton::add_state ( const qdInterfaceElementState st)

Добавляет состояние кнопки.

Параметры из состояния st копируются во внутренние данные.

◆ insert_state()

bool QDEngine::qdInterfaceButton::insert_state ( int  insert_before,
const qdInterfaceElementState st 
)

Добавляет состояние кнопки.

Новое состояние добавляется в список перед состоянием номер insert_before. Параметры из состояния st копируются во внутренние данные.

◆ modify_state()

bool QDEngine::qdInterfaceButton::modify_state ( int  state_num,
const qdInterfaceElementState st 
)
inline

Модифицирует состояние кнопки.

Соответствующему состоянию присваивается значение st.

◆ change_state()

bool QDEngine::qdInterfaceButton::change_state ( bool  direction = true)

Переключает состояние кнопки.

Если direction == true включается следующее состояние, если false - предыдущее.

◆ init()

bool QDEngine::qdInterfaceButton::init ( bool  is_game_active = true)
virtual

Инициализация элемента.

Вызывается каждый раз при заходе на экран, которому принадлежит элемент.

Implements QDEngine::qdInterfaceElement.


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