chapter_list Class Reference

Interface for object storing list of chapters. More...

#include <chapterizer.h>

Inheritance diagram for chapter_list:

List of all members.

Public Member Functions
virtual t_size	get_chapter_count () const =0
	Returns number of chapters.
virtual const file_info &	get_info (t_size p_chapter) const =0
virtual void	set_chapter_count (t_size p_count)=0
	Sets number of chapters.
virtual void	set_info (t_size p_chapter, const file_info &p_info)=0
void	copy (const chapter_list &p_source)
	Copies contents of specified chapter_list object to this object.
const chapter_list &	operator= (const chapter_list &p_source)
Protected Member Functions
	chapter_list ()
	~chapter_list ()

---

Detailed Description

Interface for object storing list of chapters.

---

Constructor & Destructor Documentation

chapter_list::chapter_list

(

)

[inline, protected]

chapter_list::~chapter_list

(

)

[inline, protected]

---

Member Function Documentation

virtual t_size chapter_list::get_chapter_count

(

)

const [pure virtual]

Returns number of chapters.

Implemented in chapter_list_impl.

virtual const file_info& chapter_list::get_info

(

t_size

p_chapter

)

const [pure virtual]

Queries description of specified chapter.

Parameters:

p_chapter

Index of chapter to query, greater or equal zero and less than get_chapter_count() value. If p_chapter value is out of valid range, results are undefined (e.g. crash).

Returns:

reference to file_info object describing specified chapter (length part of file_info indicates distance between beginning of this chapter and next chapter mark). Returned reference value for temporary use only, becomes invalid after any non-const operation on the chapter_list object.

Implemented in chapter_list_impl.

virtual void chapter_list::set_chapter_count

(

t_size

p_count

)

[pure virtual]

Sets number of chapters.

Implemented in chapter_list_impl.

virtual void chapter_list::set_info	(	t_size	p_chapter,
		const file_info &	p_info
	)			[pure virtual]

Modifies description of specified chapter.

Parameters:

	p_chapter_index	Index of chapter to modify, greater or equal zero and less than get_chapter_count() value. If p_chapter value is out of valid range, results are undefined (e.g. crash).
	p_info	New chapter description. Note that length part of file_info is used to calculate chapter marks.

Implemented in chapter_list_impl.

void chapter_list::copy

(

const chapter_list &

p_source

)

Copies contents of specified chapter_list object to this object.

const chapter_list& chapter_list::operator=

(

const chapter_list &

p_source

)

[inline]

Reimplemented in chapter_list_impl.

---

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

• foobar2000/SDK/chapterizer.h