• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • KDevelop Platform Libraries
  • Sitemap
  • Contact Us
 

sublime

Sublime::View

Sublime::View Class Reference

#include <view.h>

Inheritance diagram for Sublime::View:

Inheritance graph
[legend]

List of all members.


Detailed Description

View - the wrapper to the widget that knows about its document.

Views are the convenient way to manage a widget. It is specifically designed to be light and fast. Use Document::createView() to get the new view for the document and call View::widget() to create and get the actual widget.

It is not possible to create a view by hand. You need either subclass it or use a Document.

If you create a subclass of View you need to override Sublime::View::createWidget to provide a custom widget for your view.

Definition at line 45 of file view.h.


Public Slots

void requestRaise ()

Signals

void raise (Sublime::View *)
void statusChanged (Sublime::View *)

Public Member Functions

Document * document () const
bool hasWidget () const
virtual void setState (const QString &state)
QList< QAction * > toolBarActions () const
virtual QString viewState () const
virtual QString viewStatus () const
QWidget * widget (QWidget *parent=0)

Protected Member Functions

virtual QWidget * createWidget (QWidget *parent)
 View (Document *doc)

Member Function Documentation

QWidget * Sublime::View::createWidget ( QWidget *  parent  )  [protected, virtual]

override this function to create a custom widget in your View subclass

Parameters:
parent the parent widget
Returns:
a new widget which is used for this view

Definition at line 83 of file view.cpp.

Document * Sublime::View::document (  )  const

Returns:
the document for this view.

Definition at line 68 of file view.cpp.

bool Sublime::View::hasWidget (  )  const

Returns:
true if this view has an initialized widget.

Definition at line 88 of file view.cpp.

void Sublime::View::setState ( const QString &  state  )  [virtual]

Restore view state from configuration.

Definition at line 103 of file view.cpp.

void Sublime::View::statusChanged ( Sublime::View *   )  [signal]

Notify that the status for this document has changed.

QList< QAction * > Sublime::View::toolBarActions (  )  const

Returns:
the toolbar actions for this view, this needs to be called _after_ the first call to widget()

Definition at line 108 of file view.cpp.

QString Sublime::View::viewState (  )  const [virtual]

Retrieve view state for saving into configuration.

Definition at line 98 of file view.cpp.

QString Sublime::View::viewStatus (  )  const [virtual]

Retrieve information to be placed in the status bar.

Definition at line 118 of file view.cpp.

QWidget * Sublime::View::widget ( QWidget *  parent = 0  ) 

Returns:
widget for this view (creates it if it's not yet created).

Definition at line 73 of file view.cpp.


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

sublime

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

KDevelop Platform Libraries

Skip menu "KDevelop Platform Libraries"
  • interfaces
  • language
  •   duchain
  •   editor
  • outputview
  • project
  • shell
  • sublime
  • util
  • vcs
Generated for KDevelop Platform Libraries by doxygen 1.5.4
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