• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdesdk API Reference
  • KDE Home
  • Contact Us
 

okteta

  • Okteta
  • FileByteArrayModel
Public Member Functions | Protected Attributes | List of all members
Okteta::FileByteArrayModel Class Reference

#include <filebytearraymodel.h>

Inheritance diagram for Okteta::FileByteArrayModel:
Inheritance graph
[legend]

Public Member Functions

 FileByteArrayModel (int pageNumber=50, int pageSize=4096, QObject *parent=0)
 
virtual ~FileByteArrayModel ()
 
virtual Byte byte (Address offset) const
 
bool close ()
 
virtual Size fill (Byte fillByte, Address offset=0, Size fillLength=-1)
 
virtual Size insert (Address offset, const Byte *insertData, int insertLength)
 
virtual bool isModified () const
 
bool isOpen () const
 
virtual bool isReadOnly () const
 
bool open (const QString &filename)
 
virtual Size remove (const AddressRange &removeRange)
 
virtual Size replace (const AddressRange &removeRange, const Byte *insertData, int insertLength)
 
virtual void setByte (Address offset, Byte byte)
 
virtual void setModified (bool modified=true)
 
void setReadOnly (bool readOnly=true)
 
virtual Size size () const
 
virtual bool swap (Address firstStart, const AddressRange &secondRange)
 
- Public Member Functions inherited from Okteta::AbstractByteArrayModel
virtual ~AbstractByteArrayModel ()
 
virtual Size copyTo (Byte *dest, const AddressRange &copyRange) const
 
Size copyTo (Byte *dest, Address offset, Size copyLength) const
 
Size fill (Byte fillChar, const AddressRange &fillRange)
 
virtual Address indexOf (const Byte *pattern, int patternLength, Address fromOffset=0, Address toOffset=-1) const
 
Address indexOf (const QByteArray &pattern, Address fromOffset=0, Address toOffset=-1) const
 
Address indexOfCaseInsensitive (const CharCodec *charCodec, const QByteArray &pattern, Address fromOffset=0, Address toOffset=-1) const
 
Size insert (Address offset, const QByteArray &insertData)
 
virtual Address lastIndexOf (const Byte *pattern, int patternLength, Address fromOffset=-1, Address toOffset=0) const
 
Address lastIndexOf (const QByteArray &pattern, Address fromOffset=-1, Address toOffset=0) const
 
Address lastIndexOfCaseInsensitive (const CharCodec *charCodec, const QByteArray &pattern, Address fromOffset=-1, Address toOffset=0) const
 
Size remove (Address offset, Size removeLength)
 
Size replace (const AddressRange &removeRange, const QByteArray &insertData)
 
Size replace (Address offset, Size removeLength, const Byte *insertData, Size insertLength)
 

Protected Attributes

FileByteArrayModelPrivate *const d
 

Additional Inherited Members

- Signals inherited from Okteta::AbstractByteArrayModel
void contentsChanged (const Okteta::ArrayChangeMetricsList &changeList)
 
void modifiedChanged (bool isModified)
 
void readOnlyChanged (bool isReadOnly)
 
void searchedBytes (Okteta::Size bytes) const
 
- Protected Member Functions inherited from Okteta::AbstractByteArrayModel
 AbstractByteArrayModel (QObject *parent=0)
 

Detailed Description

Author
Friedrich W. H. Kossebau

Definition at line 39 of file filebytearraymodel.h.

Constructor & Destructor Documentation

Okteta::FileByteArrayModel::FileByteArrayModel ( int  pageNumber = 50,
int  pageSize = 4096,
QObject *  parent = 0 
)
explicit

default is only 50*4k = 200k memory image

Definition at line 34 of file filebytearraymodel.cpp.

Okteta::FileByteArrayModel::~FileByteArrayModel ( )
virtual

Definition at line 59 of file filebytearraymodel.cpp.

Member Function Documentation

Byte Okteta::FileByteArrayModel::byte ( Address  offset) const
virtual

locates working range The idea behind is to tell buffer which range will be requested in the following time, so that e.g.

the corresponding pages will be loaded in advance TODO: do we really need this? Where will this lead to real enhancements?

Parameters
Range
Returns
true if successfully, false otherwiseconvenience function, same as above creates an iterator to expects pointer to memory, should be in prepared range it is only expected to be a valid pointer until any further call to this or any modifying function
Parameters
Section
Returns
pointer to convenience function, same as above requests a single byte if the offset is not valid the behaviour is undefined
Parameters
offsetoffset of the datum requested

Implements Okteta::AbstractByteArrayModel.

Definition at line 48 of file filebytearraymodel.cpp.

bool Okteta::FileByteArrayModel::close ( )

Definition at line 57 of file filebytearraymodel.cpp.

Size Okteta::FileByteArrayModel::fill ( Byte  fillByte,
Address  offset = 0,
Size  fillLength = -1 
)
virtual

fills the buffer with the FillChar.

If the buffer is to small it will be extended as much as possible.

Parameters
fillBytebyte to use
offsetposition where the filling starts
fillLengthnumber of bytes to fill. If Length is -1, the buffer is filled till the end.
Returns
number of filled bytes

Implements Okteta::AbstractByteArrayModel.

Definition at line 53 of file filebytearraymodel.cpp.

Size Okteta::FileByteArrayModel::insert ( Address  offset,
const Byte *  insertData,
int  insertLength 
)
virtual

inserts bytes copied from the given source at Position.

The original data beginnung at the position is moved with the buffer enlarged as needed If the buffer is readOnly this is a noop and returns 0.

Parameters
offset
insertDatadata source
insertLengthnumber of bytes to copy
Returns
length of inserted data

Reimplemented from Okteta::AbstractByteArrayModel.

Definition at line 50 of file filebytearraymodel.cpp.

bool Okteta::FileByteArrayModel::isModified ( ) const
virtual
Returns
true if the buffer has been modified, false otherwise

Implements Okteta::AbstractByteArrayModel.

Definition at line 42 of file filebytearraymodel.cpp.

bool Okteta::FileByteArrayModel::isOpen ( ) const

Definition at line 43 of file filebytearraymodel.cpp.

bool Okteta::FileByteArrayModel::isReadOnly ( ) const
virtual

Default returns true.

Returns
true if the buffer can only be read, false if writing is allowed

Reimplemented from Okteta::AbstractByteArrayModel.

Definition at line 41 of file filebytearraymodel.cpp.

bool Okteta::FileByteArrayModel::open ( const QString &  filename)

Definition at line 56 of file filebytearraymodel.cpp.

Size Okteta::FileByteArrayModel::remove ( const AddressRange &  removeRange)
virtual

removes beginning with position as much as possible

Parameters
removeRange
Returns
length of removed data

Reimplemented from Okteta::AbstractByteArrayModel.

Definition at line 51 of file filebytearraymodel.cpp.

Size Okteta::FileByteArrayModel::replace ( const AddressRange &  removeRange,
const Byte *  insertData,
int  insertLength 
)
virtual

replaces as much as possible

Parameters
removeRange
insertData
insertLength
Returns
length of inserted data

Implements Okteta::AbstractByteArrayModel.

Definition at line 52 of file filebytearraymodel.cpp.

void Okteta::FileByteArrayModel::setByte ( Address  offset,
Byte  byte 
)
virtual

sets a single byte if the offset is not valid the behaviour is undefined

Parameters
offsetoffset of the datum requested
bytenew byte value

Implements Okteta::AbstractByteArrayModel.

Definition at line 47 of file filebytearraymodel.cpp.

void Okteta::FileByteArrayModel::setModified ( bool  modified = true)
virtual

sets the modified flag for the buffer

Parameters
modified

Implements Okteta::AbstractByteArrayModel.

Definition at line 46 of file filebytearraymodel.cpp.

void Okteta::FileByteArrayModel::setReadOnly ( bool  isReadOnly = true)
virtual

sets the readonly flag for the byte array if this is possible.

Default implementation does not do anything.

Parameters
isReadOnlynew state

Reimplemented from Okteta::AbstractByteArrayModel.

Definition at line 45 of file filebytearraymodel.cpp.

Size Okteta::FileByteArrayModel::size ( ) const
virtual
Returns
the size of the data

Implements Okteta::AbstractByteArrayModel.

Definition at line 40 of file filebytearraymodel.cpp.

bool Okteta::FileByteArrayModel::swap ( Address  firstStart,
const AddressRange &  secondRange 
)
virtual

moves the second section before the start of the first which is the same as moving the first behind the second.

Parameters
firstStartposition of the data where the section should be moved behind
secondRangedata range to be moved
Returns
if operation was successful, otherwise

Implements Okteta::AbstractByteArrayModel.

Definition at line 54 of file filebytearraymodel.cpp.

Member Data Documentation

FileByteArrayModelPrivate* const Okteta::FileByteArrayModel::d
protected

Definition at line 70 of file filebytearraymodel.h.


The documentation for this class was generated from the following files:
  • filebytearraymodel.h
  • filebytearraymodel.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:04:13 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

okteta

Skip menu "okteta"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdesdk API Reference

Skip menu "kdesdk API Reference"
  • kapptemplate
  • kcachegrind
  • kompare
  • lokalize
  • okteta
  • umbrello
  •   umbrello

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal