• Skip to content
  • Skip to link menu
KDE 3.5 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

kviewshell

PageView Class Reference

#include <pageView.h>

Inheritance diagram for PageView:

Inheritance graph
[legend]

List of all members.


Public Slots

void calculateCurrentPageNumber ()
void layoutPages (bool zoomChanged=false)
bool readDown ()
bool readUp ()
void scrollBottom ()
void scrollDown ()
void scrollLeft ()
void scrollRight ()
void scrollTop ()
void scrollUp ()
void setFullScreenMode (bool fullScreen)
void slotEnableMoveTool (bool enable)
void slotShowScrollbars (bool)

Signals

void currentPageChanged (const PageNumber &)
void pageSizeChanged (const QSize &size)
void viewSizeChanged (const QSize &size)
void wheelEventReceived (QWheelEvent *)

Public Member Functions

void addChild (QPtrVector< DocumentWidget > *wdgList)
bool atBottom () const
bool atTop () const
int distanceBetweenPages ()
bool fullScreenMode ()
Q_UINT8 getNrColumns () const
Q_UINT8 getNrRows () const
bool isContinuous () const
bool isMoveToolEnabled () const
void moveViewportToWidget (QWidget *widget, int y=0)
bool overviewMode ()
 PageView (QWidget *parent=0, const char *name=0)
void setContinuousViewMode (bool continuous)
void setNrColumns (Q_UINT8 cols)
void setNrRows (Q_UINT8 rows)
bool singlePageFullScreenMode ()
 ~PageView ()

Protected Member Functions

void contentsMouseMoveEvent (QMouseEvent *)
void contentsMousePressEvent (QMouseEvent *)
void contentsMouseReleaseEvent (QMouseEvent *)
void contentsWheelEvent (QWheelEvent *)
void keyPressEvent (QKeyEvent *)
void viewportPaintEvent (QPaintEvent *)
void viewportResizeEvent (QResizeEvent *)

Detailed Description

Definition at line 37 of file pageView.h.


Constructor & Destructor Documentation

PageView::PageView ( QWidget *  parent = 0,
const char *  name = 0 
)

Definition at line 33 of file pageView.cpp.

PageView::~PageView (  )  [inline]

Definition at line 43 of file pageView.h.


Member Function Documentation

void PageView::addChild ( QPtrVector< DocumentWidget > *  wdgList  ) 

Definition at line 61 of file pageView.cpp.

bool PageView::atBottom (  )  const

Definition at line 79 of file pageView.cpp.

bool PageView::atTop (  )  const

Return true if the top resp.

bottom of the page is visible.

Definition at line 73 of file pageView.cpp.

void PageView::calculateCurrentPageNumber (  )  [slot]

Definition at line 583 of file pageView.cpp.

void PageView::contentsMouseMoveEvent ( QMouseEvent *  e  )  [protected]

Reimplemented from QScrollView.

Definition at line 221 of file pageView.cpp.

void PageView::contentsMousePressEvent ( QMouseEvent *  e  )  [protected]

Reimplemented from QScrollView.

Definition at line 196 of file pageView.cpp.

void PageView::contentsMouseReleaseEvent ( QMouseEvent *   )  [protected]

Reimplemented from QScrollView.

Definition at line 216 of file pageView.cpp.

void PageView::contentsWheelEvent ( QWheelEvent *  e  )  [protected]

Reimplemented from QScrollView, because the kviepart needs to handle the wheel events itself.

The wheel event is passed on by emitting the singal "wheelEventReceived". Nothing else is done.

Reimplemented from QScrollView.

Definition at line 445 of file pageView.cpp.

void PageView::currentPageChanged ( const PageNumber &   )  [signal]

int PageView::distanceBetweenPages (  )  [inline]

Distance between pages in pixels (this is independent of the zoom level).

Definition at line 85 of file pageView.h.

bool PageView::fullScreenMode (  )  [inline]

Definition at line 53 of file pageView.h.

Q_UINT8 PageView::getNrColumns (  )  const [inline]

Returns the number of columns into which the widgets are aligned.

This method returns the number of colums actually used to display the widgets.

Warning:
This method need not return the number columns set in the setViewMode() method. For instance, if the viewmode KVSPrefs::EnumViewMode::ContinuousFacing is set, but there is only one widget, then only one column is used, and the method returns the number one.
If there aren't any widgets, the number 1 is returned.

Returns:
Number of columns used, or 1 if there aren't any widgets. The number i returned always satisfies 1 <= i <= nrCols, where nrCols is the private variable of the same nane.

Definition at line 74 of file pageView.h.

Q_UINT8 PageView::getNrRows (  )  const [inline]

Definition at line 76 of file pageView.h.

bool PageView::isContinuous (  )  const [inline]

Definition at line 77 of file pageView.h.

bool PageView::isMoveToolEnabled (  )  const [inline]

Definition at line 90 of file pageView.h.

void PageView::keyPressEvent ( QKeyEvent *  e  )  [protected]

Definition at line 174 of file pageView.cpp.

void PageView::layoutPages ( bool  zoomChanged = false  )  [slot]

Set layout of the page widgets according to the current viewmode and zoomlevel.

Set zoomChanged = true if the the layout needs updateing because the zoomlevel has changed.

Definition at line 298 of file pageView.cpp.

void PageView::moveViewportToWidget ( QWidget *  widget,
int  y = 0 
)

Moves the viewport so that the widget is at the top left corner.

Definition at line 451 of file pageView.cpp.

bool PageView::overviewMode (  )  [inline]

Definition at line 55 of file pageView.h.

void PageView::pageSizeChanged ( const QSize &  size  )  [signal]

bool PageView::readDown (  )  [slot]

Definition at line 114 of file pageView.cpp.

bool PageView::readUp (  )  [slot]

Definition at line 85 of file pageView.cpp.

void PageView::scrollBottom (  )  [slot]

Definition at line 164 of file pageView.cpp.

void PageView::scrollDown (  )  [slot]

Definition at line 154 of file pageView.cpp.

void PageView::scrollLeft (  )  [slot]

Definition at line 149 of file pageView.cpp.

void PageView::scrollRight (  )  [slot]

Definition at line 144 of file pageView.cpp.

void PageView::scrollTop (  )  [slot]

Definition at line 169 of file pageView.cpp.

void PageView::scrollUp (  )  [slot]

Definition at line 159 of file pageView.cpp.

void PageView::setContinuousViewMode ( bool  continuous  ) 

Definition at line 255 of file pageView.cpp.

void PageView::setFullScreenMode ( bool  fullScreen  )  [slot]

Definition at line 276 of file pageView.cpp.

void PageView::setNrColumns ( Q_UINT8  cols  ) 

Sets the number of columns into which the widgets are aligned.

If nothing is set, '2' is the default.

Definition at line 245 of file pageView.cpp.

void PageView::setNrRows ( Q_UINT8  rows  ) 

Definition at line 250 of file pageView.cpp.

bool PageView::singlePageFullScreenMode (  ) 

Definition at line 260 of file pageView.cpp.

void PageView::slotEnableMoveTool ( bool  enable  )  [slot]

Definition at line 588 of file pageView.cpp.

void PageView::slotShowScrollbars ( bool  status  )  [slot]

Turn the scrollbars on/off.

Definition at line 265 of file pageView.cpp.

void PageView::viewportPaintEvent ( QPaintEvent *  e  )  [protected]

Reimplemented from QScrollView.

Definition at line 490 of file pageView.cpp.

void PageView::viewportResizeEvent ( QResizeEvent *  e  )  [protected]

Reimplemented from QScrollView to make sure that the page is centered when it fits in the viewport.

Reimplemented from QScrollView.

Definition at line 233 of file pageView.cpp.

void PageView::viewSizeChanged ( const QSize &  size  )  [signal]

void PageView::wheelEventReceived ( QWheelEvent *   )  [signal]

This signal is emitted when the scrollView receives a mouse wheel event.


The documentation for this class was generated from the following files:
  • pageView.h
  • pageView.cpp

kviewshell

Skip menu "kviewshell"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members

API Reference

Skip menu "API Reference"
  • kviewshell
Generated for API Reference by doxygen 1.5.9
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal