ScummVM API documentation
QDEngine::qdInterfaceSave Class Reference

Интерфейсный элемент - сэйв. More...

#include <qd_interface_save.h>

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

Public Member Functions

 qdInterfaceSave (const qdInterfaceSave &sv)
 
qdInterfaceSave & operator= (const qdInterfaceSave &sv)
 
qdInterfaceElement::element_type get_element_type () const
 Возвращает тип элемента. More...
 
bool mouse_handler (int x, int y, mouseDispatcher::mouseEvent ev)
 Обработчик событий мыши. More...
 
bool keyboard_handler (Common::KeyCode vkey)
 Обработчик ввода с клавиатуры. More...
 
bool init (bool is_game_active=true)
 Инициализация элемента. More...
 
bool redraw () const
 Отрисовка элемента. More...
 
grScreenRegion screen_region () const
 
int size_x () const
 Возвращает размер элемента по горизонтали в пикселах. More...
 
int size_y () const
 Возвращает размер элемента по вертикали в пикселах. More...
 
int thumbnail_size_x () const
 Возвращает размер картики-превью по горизонтали в пикселах.
 
int thumbnail_size_y () const
 Возвращает размер картики-превью по вертикали в пикселах.
 
void set_thumbnail_size_x (int sx)
 Назначает размер картики-превью по горизонтали в пикселах.
 
void set_thumbnail_size_y (int sy)
 Назначает размер картики-превью по вертикали в пикселах.
 
int text_dx () const
 Смещение текста, выводимого в сэйве, относительно левого-верхнего угла
 
int text_dy () const
 
void set_test_dx (int val)
 
void set_test_dy (int val)
 
bool quant (float dt)
 Обсчет логики, параметр - время в секундах. More...
 
bool hit_test (int x, int y) const
 Возвращает true, если точка с экранными координатами (x,у) попадает в элемент. More...
 
int save_ID () const
 Возвращает номер сэйва.
 
void set_save_ID (int id)
 Устанавливает номер сэйва.
 
void set_frame_animation_file (const Common::Path &name, qdInterfaceElementState::state_mode_t mode=qdInterfaceElementState::MOUSE_HOVER_MODE)
 Устанавливает имя файла для анимации. More...
 
const Common::Path frame_animation_file (qdInterfaceElementState::state_mode_t mode=qdInterfaceElementState::MOUSE_HOVER_MODE) const
 Возвращает имя файла для анимации.
 
int frame_animation_flags (qdInterfaceElementState::state_mode_t mode=qdInterfaceElementState::MOUSE_HOVER_MODE) const
 Возвращает флаги анимации.
 
void set_frame_animation_flag (int fl, qdInterfaceElementState::state_mode_t mode=qdInterfaceElementState::MOUSE_HOVER_MODE)
 Устанавливает флаг анимации.
 
void drop_frame_animation_flag (int fl, qdInterfaceElementState::state_mode_t mode=qdInterfaceElementState::MOUSE_HOVER_MODE)
 Скидывает флаг анимации.
 
bool check_frame_animation_flag (int fl, qdInterfaceElementState::state_mode_t mode=qdInterfaceElementState::MOUSE_HOVER_MODE) const
 Возвращает true, если для анимации установлен флаг fl.
 
bool frame_has_animation (qdInterfaceElementState::state_mode_t mode=qdInterfaceElementState::MOUSE_HOVER_MODE) const
 Возвращает true, если к сейву привязана анимация рамки.
 
void set_frame_sound_file (const char *name, qdInterfaceElementState::state_mode_t mode=qdInterfaceElementState::MOUSE_HOVER_MODE)
 
const Common::Path frame_sound_file (qdInterfaceElementState::state_mode_t mode=qdInterfaceElementState::MOUSE_HOVER_MODE) const
 
bool isAutosaveSlot () const
 
void setAutosaveSlot (bool state)
 
void set_title (const char *title)
 
const char * title () const
 
bool perform_save ()
 Осуществить сохранение текущего состояния игры в ячейку сэйва.
 
- Public Member Functions inherited from QDEngine::qdInterfaceElement
 qdInterfaceElement (const qdInterfaceElement &el)
 
qdInterfaceElement & operator= (const qdInterfaceElement &el)
 
virtual element_type get_element_type () const =0
 Возвращает тип элемента. More...
 
option_ID_t option_ID () const
 Возвращает идентификатор настройки игры, связанной с элементом.
 
void set_option_ID (option_ID_t id)
 Устанавливает идентификатор настройки игры, связанной с элементом.
 
bool linked_to_option () const
 Возвращает true, если с элементом связана настройка игры.
 
virtual int option_value () const
 Возвращает значение настройки игры, связанной с элементом. More...
 
virtual bool set_option_value (int value)
 Устанавливает значение настройки игры, связанной с элементом. More...
 
virtual const Vect2i r () const
 Возвращает экранные координаты центра элемента. More...
 
void set_r (const Vect2i &v)
 Устанавливает экранные координаты центра элемента.
 
virtual int size_x () const
 Возвращает размер элемента по горизонтали в пикселах. More...
 
virtual int size_y () const
 Возвращает размер элемента по вертикали в пикселах. More...
 
virtual grScreenRegion screen_region () const
 
const grScreenRegion & last_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
 Отрисовка элемента. More...
 
virtual bool need_redraw () const
 
virtual bool post_redraw ()
 
virtual bool mouse_handler (int x, int y, mouseDispatcher::mouseEvent ev)=0
 Обработчик событий мыши. More...
 
virtual bool keyboard_handler (Common::KeyCode vkey)=0
 Обработчик ввода с клавиатуры. More...
 
virtual bool char_input_handler (int vkey)
 Обработчик ввода символов с клавиатуры. More...
 
virtual void hover_clear ()
 
virtual bool init (bool is_game_active=true)=0
 Инициализация элемента. More...
 
virtual bool quant (float dt)
 Обсчет логики, параметр - время в секундах. More...
 
const qdAnimation & animation () const
 
bool set_animation (const qdAnimation *anm, int anm_flags=0)
 Устанавливает анимацию для элемента.
 
bool set_state (const qdInterfaceElementState *p)
 Включает состояние элемента.
 
qdResource * add_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.
 
virtual bool hit_test (int x, int y) const
 Возвращает true, если точка с экранными координатами (x,у) попадает в элемент. More...
 
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)
 Устанавливает владельца объекта.
 
qdInterfaceObjectBase * owner () const
 Возвращает указатель на владельца объекта.
 
- Public Member Functions inherited from QDEngine::qdNamedObjectBase
 qdNamedObjectBase (const qdNamedObjectBase &obj)
 
qdNamedObjectBase & operator= (const qdNamedObjectBase &obj)
 
const char * name () const
 Возвращает имя объекта.
 
void set_name (const char *p)
 Устанавливает имя объекта.
 

Static Public Member Functions

static void set_save_mode (bool state)
 Устанавливает режим работы - записывать (state == true) или загружать (state == false) сэйвы.
 
- Static Public Member Functions inherited from QDEngine::qdInterfaceElement
static qdInterfaceElement * create_element (element_type tp)
 Создание элемента интерфейса заданного типа.
 
static void destroy_element (qdInterfaceElement *p)
 Уничтожение элемента интерфейса.
 

Protected Member Functions

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

Detailed Description

Интерфейсный элемент - сэйв.

Member Function Documentation

◆ get_element_type()

qdInterfaceElement::element_type QDEngine::qdInterfaceSave::get_element_type ( ) const
inlinevirtual

Возвращает тип элемента.

Implements QDEngine::qdInterfaceElement.

◆ mouse_handler()

bool QDEngine::qdInterfaceSave::mouse_handler ( int  x,
int  y,
mouseDispatcher::mouseEvent  ev 
)
virtual

Обработчик событий мыши.

Implements QDEngine::qdInterfaceElement.

◆ keyboard_handler()

bool QDEngine::qdInterfaceSave::keyboard_handler ( Common::KeyCode  vkey)
virtual

Обработчик ввода с клавиатуры.

Implements QDEngine::qdInterfaceElement.

◆ init()

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

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

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

Implements QDEngine::qdInterfaceElement.

◆ redraw()

bool QDEngine::qdInterfaceSave::redraw ( ) const
virtual

Отрисовка элемента.

Reimplemented from QDEngine::qdInterfaceElement.

◆ screen_region()

grScreenRegion QDEngine::qdInterfaceSave::screen_region ( ) const
virtual

Reimplemented from QDEngine::qdInterfaceElement.

◆ size_x()

int QDEngine::qdInterfaceSave::size_x ( ) const
virtual

Возвращает размер элемента по горизонтали в пикселах.

Reimplemented from QDEngine::qdInterfaceElement.

◆ size_y()

int QDEngine::qdInterfaceSave::size_y ( ) const
virtual

Возвращает размер элемента по вертикали в пикселах.

Reimplemented from QDEngine::qdInterfaceElement.

◆ quant()

bool QDEngine::qdInterfaceSave::quant ( float  dt)
virtual

Обсчет логики, параметр - время в секундах.

Reimplemented from QDEngine::qdInterfaceElement.

◆ hit_test()

bool QDEngine::qdInterfaceSave::hit_test ( int  x,
int  y 
) const
virtual

Возвращает true, если точка с экранными координатами (x,у) попадает в элемент.

Reimplemented from QDEngine::qdInterfaceElement.

◆ set_frame_animation_file()

void QDEngine::qdInterfaceSave::set_frame_animation_file ( const Common::Path &  name,
qdInterfaceElementState::state_mode_t  mode = qdInterfaceElementState::MOUSE_HOVER_MODE 
)
inline

Устанавливает имя файла для анимации.

Если надо убрать анимацию - передать NULL в качестве имени файла.

◆ save_script_body()

bool QDEngine::qdInterfaceSave::save_script_body ( Common::WriteStream &  fh,
int  indent = 0 
) const
protectedvirtual

Запись данных в скрипт.

Implements QDEngine::qdInterfaceElement.

◆ load_script_body()

bool QDEngine::qdInterfaceSave::load_script_body ( const xml::tag *  p)
protectedvirtual

Загрузка данных из скрипта.

Implements QDEngine::qdInterfaceElement.


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