ViewInfo is used mainly to hold the zooming, selection and scroll information. It also has some status flags. More...

#include <ViewInfo.h>

Inheritance diagram for ViewInfo:

Public Member Functions
	ViewInfo (double start, double screenDuration, double pixelsPerSecond)

void	UpdatePrefs ()

double	GetBeforeScreenWidth () const

void	SetBeforeScreenWidth (wxInt64 beforeWidth, wxInt64 screenWidth, double lowerBoundTime=0.0)

double	GetTotalWidth () const

void	WriteXMLAttributes (XMLWriter &xmlFile) const

bool	ReadXMLAttribute (const wxChar attr, const wxChar value)

void	OnTimer (wxCommandEvent &event)

Public Member Functions inherited from ZoomInfo
	ZoomInfo (double start, double pixelsPerSecond)

	~ZoomInfo ()

	ZoomInfo (const ZoomInfo &) PROHIBITED

ZoomInfo &	operator= (const ZoomInfo &) PROHIBITED

void	UpdatePrefs ()

double	PositionToTime (wxInt64 position, wxInt64 origin=0, bool ignoreFisheye=false) const

wxInt64	TimeToPosition (double time, wxInt64 origin=0, bool ignoreFisheye=false) const
	STM: Converts a project time to screen x position. More...

double	TimeRangeToPixelWidth (double timeRange) const

double	OffsetTimeByPixels (double time, wxInt64 offset, bool ignoreFisheye=false) const

bool	ZoomInAvailable () const

bool	ZoomOutAvailable () const

void	SetZoom (double pixelsPerSecond)

double	GetZoom () const

void	ZoomBy (double multiplier)

void	FindIntervals (double rate, Intervals &results, wxInt64 width, wxInt64 origin=0) const

FisheyeState	GetFisheyeState () const

bool	InFisheye (wxInt64, wxInt64 WXUNUSED(origin=0)) const

wxInt64	GetFisheyeLeftBoundary (wxInt64 WXUNUSED(origin=0)) const

wxInt64	GetFisheyeRightBoundary (wxInt64 WXUNUSED(origin=0)) const

Public Attributes
SelectedRegion	selectedRegion

double	total

wxInt64	sbarH

wxInt64	sbarScreen

wxInt64	sbarTotal

double	sbarScale

int	scrollStep

bool	bUpdateTrackIndicator

bool	bScrollBeyondZero

bool	bAdjustSelectionEdges

double	mRecentStreamTime

Public Attributes inherited from ZoomInfo
int	vpos

double	h

float	dBr

Additional Inherited Members
Public Types inherited from ZoomInfo
enum	FisheyeState { HIDDEN, PINNED, NUM_STATES }

typedef std::vector< Interval >	Intervals

Static Public Member Functions inherited from ZoomInfo
static double	GetDefaultZoom ()

static double	GetMaxZoom ()

static double	GetMinZoom ()

Protected Attributes inherited from ZoomInfo
double	zoom

Detailed Description

ViewInfo is used mainly to hold the zooming, selection and scroll information. It also has some status flags.

Definition at line 143 of file ViewInfo.h.

Constructor & Destructor Documentation

ViewInfo::ViewInfo	(	double	start,
		double	screenDuration,
		double	pixelsPerSecond
	)

Definition at line 134 of file ViewInfo.cpp.

References UpdatePrefs().

    : ZoomInfo(start, pixelsPerSecond)
    , selectedRegion()
    , total(screenDuration)
    , sbarH(0)
    , sbarScreen(1)
    , sbarTotal(1)
    , sbarScale(1.0)
    , scrollStep(16)
    , bUpdateTrackIndicator(true)
    , bScrollBeyondZero(false)
    , mRecentStreamTime(-1.0)
 {
    UpdatePrefs();
 }

Member Function Documentation

double ViewInfo::GetBeforeScreenWidth ( ) const

inline

Definition at line 151 of file ViewInfo.h.

References ZoomInfo::zoom.

Referenced by AudacityProject::FixScrollbars(), and AttachableScrollBar::SetScrollBarFromViewInfo().

    {
       return h * zoom;
    }

double ViewInfo::GetTotalWidth ( ) const

inline

Definition at line 157 of file ViewInfo.h.

References ZoomInfo::zoom.

Referenced by AudacityProject::FixScrollbars(), and AttachableScrollBar::SetScrollBarFromViewInfo().

158 { return total * zoom; }

ZoomInfo::zoom

double zoom

Definition: ViewInfo.h:50

ViewInfo::total

double total

Definition: ViewInfo.h:166

void ViewInfo::OnTimer ( wxCommandEvent & event )

Definition at line 203 of file ViewInfo.cpp.

References gAudioIO, AudioIO::GetStreamTime(), and mRecentStreamTime.

Referenced by AudacityProject::AudacityProject().

 {
    mRecentStreamTime = gAudioIO->GetStreamTime();
    event.Skip();
 }

bool ViewInfo::ReadXMLAttribute	(	const wxChar *	attr,
		const wxChar *	value
	)

Definition at line 178 of file ViewInfo.cpp.

References Internat::CompatibleToDouble(), ZoomInfo::h, SelectedRegion::HandleXMLAttribute(), selectedRegion, ZoomInfo::vpos, and ZoomInfo::zoom.

Referenced by AudacityProject::HandleXMLTag().

 {
    if (selectedRegion.HandleXMLAttribute(attr, value, wxT("sel0"), wxT("sel1")))
       return true;
 
    if (!wxStrcmp(attr, wxT("vpos"))) {
       long longVpos;
       wxString(value).ToLong(&longVpos);
       vpos = (int)(longVpos);
       return true;
    }
 
    if (!wxStrcmp(attr, wxT("h"))) {
       Internat::CompatibleToDouble(value, &h);
       return true;
    }
 
    if (!wxStrcmp(attr, wxT("zoom"))) {
       Internat::CompatibleToDouble(value, &zoom);
       return true;
    }
 
    return false;
 }

void ViewInfo::SetBeforeScreenWidth	(	wxInt64	beforeWidth,
		wxInt64	screenWidth,
		double	lowerBoundTime = `0.0`
	)

Definition at line 161 of file ViewInfo.cpp.

References ZoomInfo::h, min(), total, and ZoomInfo::zoom.

Referenced by AudacityProject::DoScroll(), and AttachableScrollBar::SetViewInfoFromScrollBar().

 {
    h =
       std::max(lowerBoundTime,
          std::min(total - screenWidth / zoom,
          beforeWidth / zoom));
 }

void ViewInfo::UpdatePrefs ( )

Definition at line 150 of file ViewInfo.cpp.

References bAdjustSelectionEdges, bScrollBeyondZero, gPrefs, TracksBehaviorsPrefs::ScrollingPreferenceDefault(), TracksBehaviorsPrefs::ScrollingPreferenceKey(), and ZoomInfo::UpdatePrefs().

Referenced by AudacityProject::HandleXMLTag(), TrackPanel::UpdatePrefs(), and ViewInfo().

 {
    ZoomInfo::UpdatePrefs();
 #ifdef EXPERIMENTAL_SCROLLING_LIMITS
    gPrefs->Read(TracksBehaviorsPrefs::ScrollingPreferenceKey(), &bScrollBeyondZero,
                 TracksBehaviorsPrefs::ScrollingPreferenceDefault());
 #endif
    gPrefs->Read(wxT("/GUI/AdjustSelectionEdges"), &bAdjustSelectionEdges,
       true);
 }

void ViewInfo::WriteXMLAttributes ( XMLWriter & xmlFile ) const

Definition at line 169 of file ViewInfo.cpp.

Referenced by AudacityProject::WriteXML().

 {
    selectedRegion.WriteXMLAttributes(xmlFile, wxT("sel0"), wxT("sel1"));
    xmlFile.WriteAttr(wxT("vpos"), vpos);
    xmlFile.WriteAttr(wxT("h"), h, 10);
    xmlFile.WriteAttr(wxT("zoom"), zoom, 10);
 }