Search for usage in LXR

Okular::TextSelection Class Reference

#include <misc.h>

Public Member Functions

 TextSelection (const NormalizedPoint &start, const NormalizedPoint &end)
 TextSelection (const TextSelection &)=delete
 ~TextSelection ()
int direction () const
NormalizedPoint end () const
void end (const NormalizedPoint &point)
int itB () const
void itB (int pos)
int itE () const
void itE (int pos)
TextSelectionoperator= (const TextSelection &)=delete
NormalizedPoint start () const

Detailed Description

Wrapper around the information needed to generate the selection area There are two assumptions inside this class:

  1. the start never changes, one instance of this class is used for one selection, therefore the start of the selection will not change, only end and direction of the selection will change. By direction we mean the direction in which the end moves in relation to the start, forward selection is when end is after the start, backward when its before.
  2. The following changes might appear during selection: a. the end moves without changing the direction (it can move up and down but not past the start): only itE will be updated b. the end moves with changing the direction then itB becomes itE if the previous direction was forward or itE becomes itB
  3. Internally it that is related to the start cursor is always at it[0] while it related to end is it[1], transition between meanings (itB/itE) is done with dir modifier;

Definition at line 33 of file misc.h.

Constructor & Destructor Documentation

◆ TextSelection()

TextSelection::TextSelection ( const NormalizedPoint start,
const NormalizedPoint end 

Creates a new text selection with the given start and end point.

Definition at line 23 of file misc.cpp.

◆ ~TextSelection()

TextSelection::~TextSelection ( )

Destroys the text selection.

Definition at line 38 of file misc.cpp.

Member Function Documentation

◆ direction()

int TextSelection::direction ( ) const

Returns the direction of the selection.

Definition at line 65 of file misc.cpp.

◆ end() [1/2]

NormalizedPoint TextSelection::end ( ) const

Returns the end point of the selection.

Definition at line 75 of file misc.cpp.

◆ end() [2/2]

void TextSelection::end ( const NormalizedPoint point)

Changes the end point of the selection to the given point.

Definition at line 43 of file misc.cpp.

◆ start()

NormalizedPoint TextSelection::start ( ) const

Returns the start point of the selection.

Definition at line 70 of file misc.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 19 2022 04:10:35 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.