wxMedia Class Reference Manual

Matthew Flatt
mflatt@cs.rice.edu
Rice University

June 1996

• Contents
• This Manual
  • Thanks
• Overview
  • Functionality
  • Basic Organization
    • Administrators
    • Styles
  • File Format
    • Encoding Snips
      • Snip Classes
      • Buffer Data
    • Global Data: Headers and Footers
    • End of Line Ambiguity
    • Flattened Text
    • Caret Ownership
    • Cut and Paste Timestamps
    • Clickbacks
  • Using the wxMedia Classes
• Main Class Reference
  • wxAddColour: wxObject
    • wxAddColour::b
    • wxAddColour::g
    • wxAddColour::r
    • wxAddColour::wxAddColour
    • wxAddColour::Get
    • wxAddColour::Set
  • wxImageSnip: wxSnip
    • wxImageSnip::wxImageSnip
    • wxImageSnip:: wxImageSnip
    • wxImageSnip::Copy
    • wxImageSnip::GetFilename
    • wxImageSnip::GetFiletype
    • wxImageSnip::LoadFile
    • wxImageSnip::Resize
    • wxImageSnip::SetBitmap
    • wxImageSnip::SetOffset
  • wxKeymap: wxObject
    • wxKeymap::wxKeymap
    • wxKeymap:: wxKeymap
    • wxKeymap::AddKeyFunction
    • wxKeymap::AddMouseFunction
    • wxKeymap::AdjustUsage
    • wxKeymap::BreakSequence
    • wxKeymap::CallFunction
    • wxKeymap::ChainToKeymap
    • wxKeymap::GetDoubleClickInterval
    • wxKeymap::HandleKeyEvent
    • wxKeymap::HandleMouseEvent
    • wxKeymap::ImpliesShift
    • wxKeymap::IsUsed
    • wxKeymap::MapFunction
    • wxKeymap::RemoveChainedKeymap
    • wxKeymap::RemoveGrabKeyFunction
    • wxKeymap::RemoveGrabMouseFunction
    • wxKeymap::SetBreakSequenceCallback
    • wxKeymap::SetDoubleClickInterval
    • wxKeymap::SetErrorCallback
    • wxKeymap::SetGrabKeyFunction
    • wxMousemap::SetGrabMouseFunction
  • wxMediaBuffer: wxObject
    • Buffer Methods
      • selection & positions
      • locations & lines
      • paragraphs
      • inserting & deleting
      • cut & paste & undo
      • styles
      • text
      • events & key mapping
      • view & administration
      • file loading & saving
      • menus
      • other
    • Buffer Tips
    • wxMediaBuffer::bufferType
    • wxMediaBuffer::AddBufferFunctions
    • wxMediaBuffer::AppendEditItems
    • wxMediaBuffer::AppendFontItems
    • wxMediaBuffer::BeginEditSequence
    • wxMediaBuffer::BeginWriteHeaderFooterToFile
    • wxMediaBuffer::ChangeStyle
    • wxMediaBuffer::Clear
    • wxMediaBuffer::ClearUndos
    • wxMediaBuffer::Copy
    • wxMediaBuffer::CopySelf
    • wxMediaBuffer::Cut
    • wxMediaBuffer::DoEdit
    • wxMediaBuffer::DoFont
    • wxMediaBuffer::EndEditSequence
    • wxMediaBuffer::EndWriteHeaderFooterToFile
    • wxMediaBuffer::GetAdmin
    • wxMediaBuffer::GetExtent
    • wxMediaBuffer::GetDescent
    • wxMediaBuffer::GetDC
    • wxMediaBuffer::GetFile
    • wxMediaBuffer::GetFilename
    • wxMediaBuffer::GetFlattenedText
    • wxMediaBuffer::GetKeymap
    • wxMediaBuffer::GetMaxUndoHistory
    • wxMediaBuffer::GetMaxHeight
    • wxMediaBuffer::GetMaxWidth
    • wxMediaBuffer::GetMinHeight
    • wxMediaBuffer::GetMinWidth
    • wxMediaBuffer::GetSnipData
    • wxMediaBuffer::GetSnipLocation
    • wxMediaBuffer::GetSpace
    • wxMediaBuffer::GetStyleList
    • wxMediaBuffer::GetViewSize
    • wxMediaBuffer::GlobalToLocal
    • wxMediaBuffer::Insert
    • wxMediaBuffer::InsertBox
    • wxMediaBuffer::InsertImage
    • wxMediaBuffer::InvalidateBitmapCache
    • wxMediaBuffer::Kill
    • wxMediaBuffer::LocalToGlobal
    • wxMediaBuffer::Lock
    • wxMediaBuffer::Modified
    • wxMediaBuffer::NeedsUpdate
    • wxMediaBuffer::OnChar
    • wxMediaBuffer::OnEvent
    • wxMediaBuffer::OnDefaultChar
    • wxMediaBuffer::OnDefaultEvent
    • wxMediaBuffer::OnLocalChar
    • wxMediaBuffer::OnLocalEvent
    • wxMediaBuffer::OnNewImageSnip
    • wxMediaBuffer::OnFocus
    • wxMediaBuffer::OnPaint
    • wxMediaBuffer::OwnCaret
    • wxMediaBuffer::Paste
    • wxMediaBuffer::Print
    • wxMediaBuffer::PutFile
    • wxMediaBuffer::OnChange
    • wxMediaBuffer::OnSaveFile
    • wxMediaBuffer::ReadFooterFromFile
    • wxMediaBuffer::ReadFromFile
    • wxMediaBuffer::ReadHeaderFromFile
    • wxMediaBuffer::Redo
    • wxMediaBuffer::Refresh
    • wxMediaBuffer::Resized
    • wxMediaBuffer::ScrollTo
    • wxMediaBuffer::SetAdmin
    • wxMediaBuffer::SetCaretOwner
    • wxMediaBuffer::SetFilename
    • wxMediaBuffer::SetKeymap
    • wxMediaBuffer::SetMaxUndoHistory
    • wxMediaBuffer::SetMaxHeight
    • wxMediaBuffer::SetMaxWidth
    • wxMediaBuffer::SetMinHeight
    • wxMediaBuffer::SetMinWidth
    • wxMediaBuffer::SetModified
    • wxMediaBuffer::SetSnipData
    • wxMediaBuffer::SetStyleList
    • wxMediaBuffer::SizeCacheInvalid
    • wxMediaBuffer::Undo
    • wxMediaBuffer::WriteFootersToFile
    • wxMediaBuffer::WriteHeadersToFile
    • wxMediaBuffer::WriteToFile
  • wxMediaCanvas: wxCanvas
    • wxMediaCanvas::wxMediaCanvas
    • wxMediaCanvas:: wxMediaCanvas
    • wxMediaCanvas::AllowScrollToLast
    • wxMediaCanvas::ForceDisplayFocus
    • wxMediaCanvas::GetMedia
    • wxMediaCanvas::IsFocusOn
    • wxMediaCanvas::OnChar
    • wxMediaCanvas::OnEvent
    • wxMediaCanvas::OnFocus
    • wxMediaCanvas::OnKillFocus
    • wxMediaCanvas::OnPaint
    • wxMediaCanvas::OnScroll
    • wxMediaCanvas::OnSetFocus
    • wxMediaCanvas::OnSize
    • wxMediaCanvas::Scroll
    • wxMediaCanvas::SetMedia
  • wxMediaEdit: wxMediaBuffer
    • wxMediaEdit::wxMediaEdit
    • wxMediaEdit:: wxMediaEdit
    • wxMediaEdit::AddEditorFunctions
    • wxMediaEdit::AfterChangeStyle
    • wxMediaEdit::AfterDelete
    • wxMediaEdit::AfterEditSequence
    • wxMediaEdit::AfterInsert
    • wxMediaEdit::CaretHidden
    • wxMediaEdit::ChangeStyle
    • wxMediaEdit::Copy
    • wxMediaEdit::Cut
    • wxMediaEdit::Delete
    • wxMediaEdit::Erase
    • wxMediaEdit::FindLine
    • wxMediaEdit::FindPosition
    • wxMediaEdit::FindPositionInLine
    • wxMediaEdit::FindString
    • wxMediaEdit::FindStringAll
    • wxMediaEdit::FindSnip
    • wxMediaEdit::FindWordbreak
    • wxMediaEdit::FlashOff
    • wxMediaEdit::FlashOn
    • wxMediaEdit::GetAnchor
    • wxMediaEdit::GetBetweenThreshold
    • wxMediaEdit::GetCharacter
    • wxMediaEdit::GetEndPosition
    • wxMediaEdit::GetFileFormat
    • wxMediaEdit::GetPosition
    • wxMediaEdit::GetRegionData
    • wxMediaEdit::GetSnipPosition
    • wxMediaEdit::GetSnipPositionAndLocation
    • wxMediaEdit::GetStartPosition
    • wxMediaEdit::GetTabs
    • wxMediaEdit::GetText
    • wxMediaEdit::GetVisibleLineRange
    • wxMediaEdit::GetVisiblePositionRange
    • wxMediaEdit::GetWordbreakMap
    • wxMediaEdit::HideCaret
    • wxMediaEdit::Insert
    • wxMediaEdit::Kill
    • wxMediaEdit::LastLine
    • wxMediaEdit::LastParagraph
    • wxMediaEdit::LastPosition
    • wxMediaEdit::LineEndPosition
    • wxMediaEdit::LineLength
    • wxMediaEdit::LineLocation
    • wxMediaEdit::LineParagraph
    • wxMediaEdit::LineStartPosition
    • wxMediaEdit::LoadFile
    • wxMediaEdit::MovePosition
    • wxMediaEdit::OnChangeStyle
    • wxMediaEdit::OnDelete
    • wxMediaEdit::OnEditSequence
    • wxMediaEdit::OnInsert
    • wxMediaBuffer::OnNewTabSnip
    • wxMediaBuffer::OnNewTextSnip
    • wxMediaEdit::ParagraphEndLine
    • wxMediaEdit::ParagraphEndPosition
    • wxMediaEdit::ParagraphStartLine
    • wxMediaEdit::ParagraphStartPosition
    • wxMediaEdit::Paste
    • wxMediaEdit::PositionLine
    • wxMediaEdit::PositionLocation
    • wxMediaEdit::PositionParagraph
    • wxMediaEdit::ReadFromFile
    • wxMediaEdit::RemoveClickback
    • wxMediaEdit::SaveFile
    • wxMediaEdit::ScrollToPosition
    • wxMediaEdit::SetAnchor
    • wxMediaEdit::SetAutowrapBitmap
    • wxMediaEdit::SetCursor
    • wxMediaEdit::SetBetweenThreshold
    • wxMediaEdit::SetClickback
    • wxMediaEdit::SetFileFormat
    • wxMediaEdit::SetPosition
    • wxMediaEdit::SetPositionBiasScroll
    • wxMediaBuffer::SetRegionData
    • wxMediaEdit::SetTabs
    • wxMediaEdit::SetWordbreakFunc
    • wxMediaEdit::SetWordbreakMap
    • wxMediaEdit::WriteToFile
  • wxMediaPasteboard: wxMediaBuffer
    • wxMediaPasteboard::wxMediaPasteboard
    • wxMediaPasteboard:: wxMediaPasteboard
    • wxMediaPasteboard::AddPasteboardFunctions
    • wxMediaPasteboard::AddSelected
    • wxMediaPasteboard::AfterDelete
    • wxMediaPasteboard::AfterInsert
    • wxMediaPasteboard::AfterMoveTo
    • wxMediaPasteboard::AfterResize
    • wxMediaPasteboard::ChangeStyle
    • wxMediaPasteboard::Delete
    • wxMediaPasteboard::Erase
    • wxMediaPasteboard::FindFirstSnip
    • wxMediaPasteboard::FindNextSelectedSnip
    • wxMediaPasteboard::FindSnip
    • wxMediaPasteboard::GetDragable
    • wxMediaPasteboard::Insert
    • wxMediaPasteboard::IsSelected
    • wxMediaPasteboard::LoadFile
    • wxMediaPasteboard::Lower
    • wxMediaPasteboard::MoveTo
    • wxMediaPasteboard::Move
    • wxMediaPasteboard::NoSelected
    • wxMediaPasteboard::OnDelete
    • wxMediaPasteboard::OnInsert
    • wxMediaPasteboard::OnMoveTo
    • wxMediaPasteboard::OnResize
    • wxMediaPasteboard::Raise
    • wxMediaPasteboard::Remove
    • wxMediaPasteboard::Resize
    • wxMediaPasteboard::SaveFile
    • wxMediaPasteboard::SetAfter
    • wxMediaPasteboard::SetBefore
    • wxMediaPasteboard::SetDragable
    • wxMediaPasteboard::SetSelected
  • wxMediaSnip: wxSnip
    • wxMediaSnip::wxMediaSnip
    • wxMediaSnip::BorderVisible
    • wxMediaSnip::GetInset
    • wxMediaSnip::GetMargin
    • wxMediaSnip::GetMaxHeight
    • wxMediaSnip::GetMaxWidth
    • wxMediaSnip::GetMinHeight
    • wxMediaSnip::GetMinWidth
    • wxMediaSnip::wxGetThisMedia
    • wxMediaSnip::Resize
    • wxMediaSnip::SetInset
    • wxMediaSnip::SetMargin
    • wxMediaSnip::SetMaxHeight
    • wxMediaSnip::SetMaxWidth
    • wxMediaSnip::SetMinHeight
    • wxMediaSnip::SetMinWidth
    • wxMediaSnip::ShowBorder
  • wxMediaStreamIn: wxObject
    • wxMediaStreamIn::wxMediaStreamIn
    • wxMediaStreamIn:: wxMediaStreamIn
    • wxMediaStreamIn::operator>>
    • wxMediaStreamIn::Get
    • wxMediaStreamIn::GetFixed
    • wxMediaStreamIn::GetString
    • wxMediaStreamIn::JumpTo
    • wxMediaStreamIn::Ok
    • wxMediaStreamIn::RemoveBoundary
    • wxMediaStreamIn::SetBoundary
    • wxMediaStreamIn::Skip
    • wxMediaStreamIn::Tell
  • wxMediaStreamOut: wxObject
    • wxMediaStreamOut::wxMediaStreamOut
    • wxMediaStreamOut:: wxMediaStreamOut
    • wxMediaStreamOut::operator<<
    • wxMediaStreamOut::JumpTo
    • wxMediaStreamOut::Ok
    • wxMediaStreamOut::Put
    • wxMediaStreamOut::PutFixed
    • wxMediaStreamOut::Tell
  • wxMultColour: wxObject
    • wxMultColour::b
    • wxMultColour::g
    • wxMultColour::r
    • wxMultColour::wxMultColour
    • wxMultColour::Get
    • wxMultColour::Set
  • wxSnip: wxObject
    • wxSnip::count
    • wxSnip::flags
    • wxSnip::snipClass
    • wxSnip::style
    • wxSnip::wxSnip
    • wxSnip::Copy
    • wxSnip::DoEdit
    • wxSnip::DoFont
    • wxSnip::Draw
    • wxSnip::FindScrollStep
    • wxSnip::GetAdmin
    • wxSnip::GetExtent
    • wxSnip::GetNumScrollSteps
    • wxSnip::GetScrollStepOffset
    • wxSnip::GetText
    • wxSnip::IsOwned
    • wxSnip::Match
    • wxSnip::MergeWith
    • wxSnip::Next
    • wxSnip::OnChar
    • wxSnip::OnEvent
    • wxSnip::OwnCaret
    • wxSnip::PartialOffset
    • wxSnip::Previous
    • wxSnip::ReleaseFromOwner
    • wxSnip::Resize
    • wxSnip::SetAdmin
    • wxSnip::SetCount
    • wxSnip::SetFlags
    • wxSnip::SizeCacheInvalid
    • wxSnip::Split
    • wxSnip::Write
  • wxSnipClass: wxObject
    • wxSnipClass::classname
    • wxSnipClass::version
    • wxSnipClass::required
    • wxSnipClass::Read
    • wxSnipClass::ReadHeader
    • wxSnipClass::ReadDone
    • wxSnipClass::WriteHeader
    • wxSnipClass::WriteDone
  • wxStyle: wxObject
    • wxStyle::GetAlignment
    • wxStyle::GetBackground
    • wxStyle::GetBaseStyle
    • wxStyle::GetDelta
    • wxStyle::GetFace
    • wxStyle::GetFamily
    • wxStyle::GetFont
    • wxStyle::GetForeground
    • wxStyle::GetName
    • wxStyle::GetSize
    • wxStyle::GetShiftStyle
    • wxStyle::GetStyle
    • wxStyle::GetWeight
    • wxStyle::GetUnderlined
    • wxStyle::IsJoin
    • wxStyle::SetBaseStyle
    • wxStyle::SetDelta
    • wxStyle::SetShiftStyle
    • wxStyle::SwitchTo
  • wxStyleDelta: wxObject
    • On and Off Settings
    • wxStyleDelta::alignmentOff
    • wxStyleDelta::alignmentOn
    • wxStyleDelta::backgroundAdd
    • wxStyleDelta::backgroundMult
    • wxStyleDelta::family
    • wxStyleDelta::face
    • wxStyleDelta::foregroundAdd
    • wxStyleDelta::foregroundMult
    • wxStyleDelta::sizeAdd
    • wxStyleDelta::sizeMult
    • wxStyleDelta::styleOff
    • wxStyleDelta::styleOn
    • wxStyleDelta::weightOff
    • wxStyleDelta::weightOn
    • wxStyleDelta::underlinedOff
    • wxStyleDelta::underlinedOn
    • wxStyleDelta::wxStyleDelta
    • wxStyleDelta:: wxStyleDelta
    • wxStyleDelta::Collapse
    • wxStyleDelta::Copy
    • wxStyleDelta::Equal
    • wxStyleDelta::SetDelta
    • wxStyleDelta::SetDeltaBackground
    • wxStyleDelta::SetDeltaFace
    • wxStyleDelta::SetDeltaForeground
  • wxStyleList: wxObject
    • wxStyleList::wxStyleList
    • wxStyleList:: wxStyleList
    • wxStyleList::AdjustUsage
    • wxStyleList::BasicStyle
    • wxStyleList::Clear
    • wxStyleList::Convert
    • wxStyleList::FindNamedStyle
    • wxStyleList::FindOrCreateJoinStyle
    • wxStyleList::FindOrCreateStyle
    • wxStyleList::ForgetNotification
    • wxStyleList::IndexToStyle
    • wxStyleList::IsUsed
    • wxStyleList::NewNamedStyle
    • wxStyleList::NotifyOnChange
    • wxStyleList::Number
    • wxStyleList::StyleToIndex
  • wxTabSnip: wxTextSnip
    • wxTabSnip::wxTabSnip
    • wxTabSnip:: wxTabSnip
  • wxTextSnip: wxSnip
    • wxTextSnip::wxTextSnip
    • wxTextSnip:: wxTextSnip
    • wxTextSnip::Copy
    • wxTextSnip::Insert
    • wxTextSnip::Read
• Detail Class Reference
  • wxBufferData: wxObject
    • wxBufferData::dataclass
    • wxBufferData::next
    • wxBufferData::wxBufferData
    • wxBufferData:: wxBufferData
    • wxBufferData::Write
  • wxBufferDataClass: wxObject
    • wxBufferDataClass::classname
    • wxBufferDataClass::required
    • wxBufferDataClass::wxBufferDataClass
    • wxBufferDataClass::Read
  • wxBufferDataClassList: wxObject
    • wxBufferDataClassList::Add
    • wxBufferDataClassList::Find
    • wxBufferDataClassList::FindPosition
    • wxBufferDataClassList::Nth
    • wxBufferDataClassList::Number
  • wxMediaAdmin: wxObject
    • wxMediaAdmin::GetDC
    • wxMediaAdmin::GetView
    • wxMediaAdmin::GrabCaret
    • wxMediaAdmin::NeedsUpdate
    • wxMediaAdmin::Resized
    • wxMediaAdmin::ScrollTo
  • wxMediaStreamInBase: wxObject
    • wxMediaStreamInBase::Bad
    • wxMediaStreamInBase::Read
    • wxMediaStreamInBase::Seek
    • wxMediaStreamInBase::Skip
    • wxMediaStreamInBase::Tell
  • wxMediaStreamInFileBase: wxMediaStreamInBase
    • wxMediaStreamInFileBase::wxMediaStreamInFileBase
  • wxMediaStreamInStringBase: wxMediaStreamInBase
    • wxMediaStreamInStringBase::wxMediaStreamInStringBase
  • wxMediaStreamOutBase: wxObject
    • wxMediaStreamOutBase::Bad
    • wxMediaStreamOutBase::Seek
    • wxMediaStreamOutBase::Tell
    • wxMediaStreamOutBase::Write
  • wxMediaStreamOutFileBase: wxMediaStreamOutBase
    • wxMediaStreamOutFileBase::wxMediaStreamOutFileBase
  • wxMediaStreamOutStringBase: wxMediaStreamOutBase
    • wxMediaStreamOutStringBase::wxMediaStreamOutStringBase
    • wxMediaStreamOutStringBase::GetString
  • wxMediaWordbreakMap: wxObject
    • wxMediaWordbreakMap::map
    • wxMediaWordbreakMap::wxMediaWordbreakMap
    • wxMediaWordbreakMap::AdjustUsage
    • wxMediaWordbreakMap::GetMap
    • wxMediaWordbreakMap::IsUsed
    • wxMediaWordbreakMap::SetMap
  • wxSnipAdmin: wxObject
    • wxSnipAdmin::GetMedia
    • wxSnipAdmin::GetDC
    • wxSnipAdmin::GetViewSize
    • wxSnipAdmin::NeedsUpdate
    • wxSnipAdmin::ReleaseSnip
    • wxSnipAdmin::Resized
    • wxSnipAdmin::ScrollTo
    • wxSnipAdmin::SetCaretOwner
  • wxSnipClassList: wxObject
    • wxSnipClassList::Add
    • wxSnipClassList::Find
    • wxSnipClassList::FindPosition
    • wxSnipClassList::Nth
    • wxSnipClassList::Number
• Functions
  • ::wxInitMedia
  • ::wxInitStyles
  • ::wxReadMediaGlobalFooter
  • ::wxReadMediaGlobalHeader
  • ::wxMediaSetXSelectionMode
  • ::wxWriteMediaGlobalFooter
  • ::wxWriteMediaGlobalHeader
• Index
• About this document ...