Aegisub/aegisub/src/ass_attachment.h
Amar Takhar 4e37bdea68 Cleanup doxygen markup.
Originally committed to SVN as r3329.
2009-07-30 04:27:48 +00:00

108 lines
2.6 KiB
C++

// Copyright (c) 2006, Rodrigo Braz Monteiro
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
// * Neither the name of the Aegisub Group nor the names of its contributors
// may be used to endorse or promote products derived from this software
// without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
// Aegisub Project http://www.aegisub.org/
//
// $Id$
/// @file ass_attachment.h
/// @see ass_attachment.cpp
/// @ingroup subs_storage
///
#pragma once
///////////
// Headers
#include "ass_entry.h"
#include "boost/shared_ptr.hpp"
#include <vector>
/// DOCME
typedef std::vector<unsigned char> DataVec;
/// @class AttachData
/// @brief DOCME
class AttachData {
private:
/// DOCME
DataVec data;
/// DOCME
wxString buffer;
public:
AttachData();
~AttachData();
DataVec &GetData();
void AddData(wxString data);
void Finish();
};
/// @class AssAttachment
/// @brief DOCME
class AssAttachment : public AssEntry {
private:
/// DOCME
boost::shared_ptr<AttachData> data;
/// DOCME
wxString filename;
public:
const DataVec &GetData();
void AddData(wxString data);
void Finish();
void Extract(wxString filename);
void Import(wxString filename);
wxString GetFileName(bool raw=false);
const wxString GetEntryData();
/// @brief DOCME
///
ASS_EntryType GetType() { return ENTRY_ATTACHMENT; }
AssEntry *Clone();
AssAttachment(wxString name);
~AssAttachment();
};