CaptureProcessOverlay::CaptureHistory

Search for usage in LXR

CaptureProcessOverlay::CaptureHistory Class Reference

#include <captureprocessoverlay.h>

Public Member Functions

bool addFrame (FrameData data)
 
bool backward ()
 
const FrameData currentFrame ()
 
bool deleteFrame (int pos)
 
bool forward ()
 
const FrameData getFrame (int pos)
 
int position ()
 
void reset ()
 
int size ()
 
void updateTargetStatistics ()
 

Public Attributes

TargetStatistics statistics
 

Detailed Description

Navigator through the capture history.

Definition at line 49 of file captureprocessoverlay.h.

Member Function Documentation

◆ addFrame()

bool CaptureProcessOverlay::CaptureHistory::addFrame ( CaptureProcessOverlay::FrameData  data)

Add a newly captured frame to the history.

Parameters
dataframe data
Returns
true iff this is a new frame, i.e. its filename does not exist in the history

Definition at line 170 of file captureprocessoverlay.cpp.

◆ backward()

bool CaptureProcessOverlay::CaptureHistory::backward ( )

Move one step backwards in the history.

Returns
true iff the move was possible within the limits

Definition at line 222 of file captureprocessoverlay.cpp.

◆ currentFrame()

const FrameData CaptureProcessOverlay::CaptureHistory::currentFrame ( )
inline

the currently pointed capture frame

Definition at line 68 of file captureprocessoverlay.h.

◆ deleteFrame()

bool CaptureProcessOverlay::CaptureHistory::deleteFrame ( int  pos)

Delete the current frame and (if possible) the corresponding file.

If the last one has been deleted, navigate to the frame before, if possible.

Returns
true iff deleting was successful

Definition at line 184 of file captureprocessoverlay.cpp.

◆ forward()

bool CaptureProcessOverlay::CaptureHistory::forward ( )

Move one step forward in the history.

Returns
true iff the move was possible within the limits

Definition at line 211 of file captureprocessoverlay.cpp.

◆ getFrame()

const FrameData CaptureProcessOverlay::CaptureHistory::getFrame ( int  pos)
inline

Obtain the frame from the given position in the history.

Definition at line 77 of file captureprocessoverlay.h.

◆ position()

int CaptureProcessOverlay::CaptureHistory::position ( )
inline

The current navigation position in the capture history.

Definition at line 73 of file captureprocessoverlay.h.

◆ reset()

void CaptureProcessOverlay::CaptureHistory::reset ( )

Reset the history.

Definition at line 205 of file captureprocessoverlay.cpp.

◆ size()

int CaptureProcessOverlay::CaptureHistory::size ( )
inline

Capture history size.

Definition at line 81 of file captureprocessoverlay.h.

◆ updateTargetStatistics()

void CaptureProcessOverlay::CaptureHistory::updateTargetStatistics ( )

Iterate over the current target history and add all those where the corresponding file exists.

Definition at line 233 of file captureprocessoverlay.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Fri Aug 12 2022 04:00:59 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.