CC708Window Class Reference

#include <libmythtv/captions/cc708window.h>

Collaboration diagram for CC708Window:

Public Types
enum	: std::uint8_t {   kAnchorUpperLeft = 0, kAnchorUpperCenter = 1, kAnchorUpperRight = 2, kAnchorCenterLeft = 3,   kAnchorCenter = 4, kAnchorCenterRight = 5, kAnchorLowerLeft = 6, kAnchorLowerCenter = 7,   kAnchorLowerRight = 8 }

Public Member Functions
	CC708Window ()=default
	~CC708Window ()
void	DefineWindow (int priority, bool visible, int anchor_point, int relative_pos, int anchor_vertical, int anchor_horizontal, int row_count, int column_count, int row_lock, int column_lock, int pen_style, int window_style)
void	Resize (uint new_rows, uint new_columns)
void	Clear (void)
void	SetWindowStyle (uint style)
void	AddChar (QChar ch)
void	IncrPenLocation (void)
void	DecrPenLocation (void)
void	SetPenLocation (uint row, uint column)
void	LimitPenLocation (void)
bool	IsPenValid (void) const
CC708Character &	GetCCChar (void) const
std::vector< CC708String * >	GetStrings (void) const
QColor	GetFillColor (void) const
uint	GetFillAlpha (void) const
bool	GetExists (void) const
bool	GetVisible (void) const
bool	GetChanged (void) const
void	SetExists (bool value)
void	SetVisible (bool value)
void	SetChanged (void)
void	ResetChanged (void)

Static Public Member Functions
static void	DisposeStrings (std::vector< CC708String * > &strings)

Public Attributes
uint	m_priority {0}
uint	m_anchor_point {0}
uint	m_relative_pos {0}
uint	m_anchor_vertical {0}
uint	m_anchor_horizontal {0}
uint	m_row_count {0}
uint	m_column_count {0}
uint	m_row_lock {0}
uint	m_column_lock {0}
uint	m_fill_color {0}
uint	m_fill_opacity {0}
uint	m_border_color {0}
uint	m_border_type {0}
uint	m_scroll_dir {0}
uint	m_print_dir {0}
uint	m_effect_dir {0}
uint	m_display_effect {0}
uint	m_effect_speed {0}
uint	m_justify {0}
uint	m_word_wrap {0}
uint	m_true_row_count {0}
uint	m_true_column_count {0}
CC708Character *	m_text {nullptr}
CC708Pen	m_pen
QRecursiveMutex	m_lock

Private Member Functions
void	Scroll (int row, int col)

Private Attributes
bool	m_visible {false}
bool	m_exists {false}
	set to false when DeleteWindow is called on the window. More...
bool	m_changed {true}

Detailed Description

Definition at line 194 of file cc708window.h.

Member Enumeration Documentation

anonymous enum

anonymous enum : std::uint8_t

Enumerator
kAnchorUpperLeft
kAnchorUpperCenter
kAnchorUpperRight
kAnchorCenterLeft
kAnchorCenter
kAnchorCenterRight
kAnchorLowerLeft
kAnchorLowerCenter
kAnchorLowerRight

Definition at line 245 of file cc708window.h.

Constructor & Destructor Documentation

CC708Window()

CC708Window::CC708Window ( )

default

~CC708Window()

CC708Window::~CC708Window

(

)

Definition at line 245 of file cc708window.cpp.

Member Function Documentation

DefineWindow()

void CC708Window::DefineWindow	(	int	priority,
		bool	visible,
		int	anchor_point,
		int	relative_pos,
		int	anchor_vertical,
		int	anchor_horizontal,
		int	row_count,
		int	column_count,
		int	row_lock,
		int	column_lock,
		int	pen_style,
		int	window_style
	)

Definition at line 108 of file cc708window.cpp.

Referenced by CC708Reader::DefineWindow().

Resize()

void CC708Window::Resize	(	uint	new_rows,
		uint	new_columns
	)

Definition at line 157 of file cc708window.cpp.

Referenced by DefineWindow().

Clear()

void CC708Window::Clear

(

void

)

Definition at line 260 of file cc708window.cpp.

Referenced by AddChar(), CC708Reader::ClearWindows(), CC708Reader::DeleteWindows(), and Resize().

SetWindowStyle()

void CC708Window::SetWindowStyle

(

uint

style

)

Definition at line 387 of file cc708window.cpp.

Referenced by DefineWindow().

AddChar()

void CC708Window::AddChar

(

QChar

ch

)

Definition at line 417 of file cc708window.cpp.

Referenced by CC708Reader::TextWrite().

IncrPenLocation()

void CC708Window::IncrPenLocation

(

void

)

Definition at line 535 of file cc708window.cpp.

Referenced by AddChar().

DecrPenLocation()

void CC708Window::DecrPenLocation

(

void

)

Definition at line 578 of file cc708window.cpp.

Referenced by AddChar().

SetPenLocation()

void CC708Window::SetPenLocation	(	uint	row,
		uint	column
	)

Definition at line 621 of file cc708window.cpp.

Referenced by AddChar(), and CC708Reader::SetPenLocation().

LimitPenLocation()

void CC708Window::LimitPenLocation

(

void

)

Definition at line 641 of file cc708window.cpp.

Referenced by AddChar(), DecrPenLocation(), DefineWindow(), IncrPenLocation(), and SetPenLocation().

IsPenValid()

bool CC708Window::IsPenValid ( void  ) const

inline

Definition at line 216 of file cc708window.h.

Referenced by AddChar().

GetCCChar()

CC708Character & CC708Window::GetCCChar

(

void

)

const

Definition at line 275 of file cc708window.cpp.

Referenced by AddChar().

GetStrings()

std::vector< CC708String * > CC708Window::GetStrings

(

void

)

const

Definition at line 284 of file cc708window.cpp.

Referenced by SubtitleScreen::DisplayCC708Subtitles(), and MythCCExtractorPlayer::Ingest708Captions().

DisposeStrings()

void CC708Window::DisposeStrings ( std::vector< CC708String * > &  strings )

static

Definition at line 378 of file cc708window.cpp.

Referenced by SubtitleScreen::DisplayCC708Subtitles(), and MythCCExtractorPlayer::Ingest708Captions().

GetFillColor()

QColor CC708Window::GetFillColor ( void  ) const

inline

Definition at line 224 of file cc708window.h.

GetFillAlpha()

uint CC708Window::GetFillAlpha ( void  ) const

inline

Definition at line 230 of file cc708window.h.

Scroll()

void CC708Window::Scroll ( int  row, int  col  )

private

Definition at line 500 of file cc708window.cpp.

Referenced by AddChar(), DecrPenLocation(), IncrPenLocation(), and SetPenLocation().

GetExists()

bool CC708Window::GetExists ( void  ) const

inline

Definition at line 287 of file cc708window.h.

Referenced by AddChar(), Clear(), DefineWindow(), SubtitleScreen::DisplayCC708Subtitles(), GetCCChar(), and Resize().

GetVisible()

bool CC708Window::GetVisible ( void  ) const

inline

Definition at line 288 of file cc708window.h.

Referenced by SubtitleScreen::DisplayCC708Subtitles(), MythCCExtractorPlayer::Ingest708Captions(), and CC708Reader::ToggleWindows().

GetChanged()

bool CC708Window::GetChanged ( void  ) const

inline

Definition at line 289 of file cc708window.h.

Referenced by SubtitleScreen::DisplayCC708Subtitles(), and MythCCExtractorPlayer::Ingest708Captions().

SetExists()

void CC708Window::SetExists ( bool  value )

inline

Definition at line 290 of file cc708window.h.

Referenced by DefineWindow(), CC708Reader::DisplayWindows(), Resize(), and ~CC708Window().

SetVisible()

void CC708Window::SetVisible ( bool  value )

inline

Definition at line 296 of file cc708window.h.

Referenced by DefineWindow(), CC708Reader::DisplayWindows(), CC708Reader::HideWindows(), and CC708Reader::ToggleWindows().

SetChanged()

void CC708Window::SetChanged ( void  )

inline

Definition at line 302 of file cc708window.h.

Referenced by AddChar(), Clear(), Resize(), and Scroll().

ResetChanged()

void CC708Window::ResetChanged ( void  )

inline

Definition at line 306 of file cc708window.h.

Referenced by SubtitleScreen::DisplayCC708Subtitles().

Member Data Documentation

m_priority

uint CC708Window::m_priority {0}

Definition at line 241 of file cc708window.h.

Referenced by DefineWindow().

m_visible

bool CC708Window::m_visible {false}

private

Definition at line 243 of file cc708window.h.

m_anchor_point

uint CC708Window::m_anchor_point {0}

Definition at line 250 of file cc708window.h.

Referenced by DefineWindow(), and FormattedTextSubtitle708::Init().

m_relative_pos

uint CC708Window::m_relative_pos {0}

Definition at line 251 of file cc708window.h.

Referenced by DefineWindow(), and FormattedTextSubtitle708::Init().

m_anchor_vertical

uint CC708Window::m_anchor_vertical {0}

Definition at line 252 of file cc708window.h.

Referenced by DefineWindow(), and FormattedTextSubtitle708::Init().

m_anchor_horizontal

uint CC708Window::m_anchor_horizontal {0}

Definition at line 253 of file cc708window.h.

Referenced by DefineWindow(), and FormattedTextSubtitle708::Init().

m_row_count

uint CC708Window::m_row_count {0}

Definition at line 254 of file cc708window.h.

Referenced by DefineWindow(), GetStrings(), Resize(), and SetPenLocation().

m_column_count

uint CC708Window::m_column_count {0}

Definition at line 255 of file cc708window.h.

Referenced by AddChar(), DefineWindow(), GetStrings(), Resize(), and SetPenLocation().

m_row_lock

uint CC708Window::m_row_lock {0}

Definition at line 256 of file cc708window.h.

Referenced by DecrPenLocation(), DefineWindow(), and IncrPenLocation().

m_column_lock

uint CC708Window::m_column_lock {0}

Definition at line 257 of file cc708window.h.

Referenced by DecrPenLocation(), DefineWindow(), and IncrPenLocation().

m_fill_color

uint CC708Window::m_fill_color {0}

Definition at line 261 of file cc708window.h.

Referenced by CC708Reader::SetWindowAttributes(), and SetWindowStyle().

m_fill_opacity

uint CC708Window::m_fill_opacity {0}

Definition at line 262 of file cc708window.h.

Referenced by CC708Reader::SetWindowAttributes(), and SetWindowStyle().

m_border_color

uint CC708Window::m_border_color {0}

Definition at line 263 of file cc708window.h.

Referenced by CC708Reader::SetWindowAttributes(), and SetWindowStyle().

m_border_type

uint CC708Window::m_border_type {0}

Definition at line 264 of file cc708window.h.

Referenced by CC708Reader::SetWindowAttributes(), and SetWindowStyle().

m_scroll_dir

uint CC708Window::m_scroll_dir {0}

Definition at line 265 of file cc708window.h.

Referenced by Scroll(), CC708Reader::SetWindowAttributes(), and SetWindowStyle().

m_print_dir

uint CC708Window::m_print_dir {0}

Definition at line 266 of file cc708window.h.

Referenced by DecrPenLocation(), IncrPenLocation(), CC708Reader::SetWindowAttributes(), and SetWindowStyle().

m_effect_dir

uint CC708Window::m_effect_dir {0}

Definition at line 267 of file cc708window.h.

Referenced by CC708Reader::SetWindowAttributes(), and SetWindowStyle().

m_display_effect

uint CC708Window::m_display_effect {0}

Definition at line 268 of file cc708window.h.

Referenced by CC708Reader::SetWindowAttributes(), and SetWindowStyle().

m_effect_speed

uint CC708Window::m_effect_speed {0}

Definition at line 269 of file cc708window.h.

Referenced by CC708Reader::SetWindowAttributes(), and SetWindowStyle().

m_justify

uint CC708Window::m_justify {0}

Definition at line 270 of file cc708window.h.

Referenced by CC708Reader::SetWindowAttributes(), and SetWindowStyle().

m_word_wrap

uint CC708Window::m_word_wrap {0}

Definition at line 271 of file cc708window.h.

Referenced by CC708Reader::SetWindowAttributes(), and SetWindowStyle().

m_true_row_count

uint CC708Window::m_true_row_count {0}

Definition at line 275 of file cc708window.h.

Referenced by AddChar(), Clear(), GetCCChar(), LimitPenLocation(), Resize(), Scroll(), SetPenLocation(), and ~CC708Window().

m_true_column_count

uint CC708Window::m_true_column_count {0}

Definition at line 276 of file cc708window.h.

Referenced by AddChar(), Clear(), DecrPenLocation(), GetCCChar(), GetStrings(), IncrPenLocation(), LimitPenLocation(), Resize(), Scroll(), SetPenLocation(), and ~CC708Window().

m_text

CC708Character* CC708Window::m_text {nullptr}

Definition at line 278 of file cc708window.h.

Referenced by AddChar(), Clear(), CC708Reader::DisplayWindows(), GetCCChar(), GetStrings(), Resize(), Scroll(), and ~CC708Window().

m_pen

CC708Pen CC708Window::m_pen

Definition at line 279 of file cc708window.h.

Referenced by AddChar(), Clear(), DecrPenLocation(), DefineWindow(), GetCCChar(), IncrPenLocation(), MythCCExtractorPlayer::Ingest708Captions(), LimitPenLocation(), Resize(), Scroll(), CC708Reader::SetPenAttributes(), CC708Reader::SetPenColor(), and SetPenLocation().

m_exists

bool CC708Window::m_exists {false}

private

set to false when DeleteWindow is called on the window.

Definition at line 283 of file cc708window.h.

m_changed

bool CC708Window::m_changed {true}

private

Definition at line 284 of file cc708window.h.

m_lock

QRecursiveMutex CC708Window::m_lock

mutable

Definition at line 310 of file cc708window.h.

Referenced by AddChar(), Clear(), DefineWindow(), SubtitleScreen::DisplayCC708Subtitles(), CC708Reader::DisplayWindows(), GetStrings(), Scroll(), and ~CC708Window().

---

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

• mythtv/libs/libmythtv/captions/cc708window.h
• mythtv/libs/libmythtv/captions/cc708window.cpp