LibreOffice
LibreOffice 6.0 SDK API Reference
Modules | Classes | Enumerations
com::sun::star::view Module Reference

Document view specific interfaces (e.g. selection access and printing). More...

Constant Groups

constants  DocumentZoomType
 These constants specify how the document content is zoomed into the document view.
 
constants  DuplexMode
 These constants specify available duplex modes.
 

Classes

service  OfficeDocumentView
 specifies a view of a standard office document. More...
 
struct  PrintableStateEvent
 specifies the print progress of an XPrintable. More...
 
service  PrinterDescriptor
 describes a printer by specifying the queue name and some settings. More...
 
struct  PrintJobEvent
 specifies the print progress of an XPrintJob. More...
 
service  PrintOptions
 describes the options for print jobs. More...
 
service  PrintSettings
 provides access to the settings for printing documents. More...
 
service  RenderDescriptor
 describes the options for Render jobs. More...
 
service  RenderOptions
 describes the options for Render jobs. More...
 
service  ViewSettings
 provides access to the settings of the controller of an office document. More...
 
interface  XControlAccess
 provides access to the controls in a view. More...
 
interface  XFormLayerAccess
 provides access to the form layer elements in a view More...
 
interface  XLineCursor
 makes it possible to move a cursor by lines within laid out text. More...
 
interface  XMultiSelectionSupplier
 makes it possible to append and remove objects from a selection. More...
 
interface  XPrintable
 offers printing functionality. More...
 
interface  XPrintableBroadcaster
 allows for getting information about a print job. More...
 
interface  XPrintableListener
 receives events about print job progress. More...
 
interface  XPrintJob
 allows for getting information about a print job. More...
 
interface  XPrintJobBroadcaster
 allows for getting information about a print job. More...
 
interface  XPrintJobListener
 receives events about print job progress. More...
 
interface  XPrintSettingsSupplier
 offers printing related settings, which affect document rendering, but are not related to the printer itself. More...
 
interface  XRenderable
 represents something that can be rendered. More...
 
interface  XScreenCursor
 makes it possible to page through the document in steps of the displayed size. More...
 
interface  XSelectionChangeListener
 makes it possible to receive an event when the current selection changes. More...
 
interface  XSelectionSupplier
 makes it possible to access and change the selection in a view. More...
 
interface  XViewCursor
 makes it possible to move a cursor up/down/left/right within laid out text. More...
 
interface  XViewSettingsSupplier
 provides access to the view settings of the object. More...
 

Enumerations

enum  PaperFormat {
  A3, A4, A5, B4,
  B5, LETTER, LEGAL, TABLOID,
  USER
}
 specifies the format (size) of the paper on a text document. More...
 
enum  PaperOrientation { PORTRAIT, LANDSCAPE }
 specifies the orientation of the paper. More...
 
enum  PrintableState {
  JOB_STARTED, JOB_COMPLETED, JOB_SPOOLED, JOB_ABORTED,
  JOB_FAILED, JOB_SPOOLING_FAILED
}
 specifies the print progress of an XPrintable. More...
 
enum  SelectionType { NONE, SINGLE, MULTI, RANGE }
 Specifies a selection type for a view that supports a selection model. More...
 

Detailed Description

Document view specific interfaces (e.g. selection access and printing).

Enumeration Type Documentation

enum PaperFormat
published

specifies the format (size) of the paper on a text document.

Enumerator
A3 

specifies the paper format as A3.

A4 

specifies the paper format as A4.

A5 

specifies the paper format as A5.

B4 

specifies the paper format as B4.

B5 

specifies the paper format as B5.

LETTER 

specifies the paper format as Letter.

LEGAL 

specifies the paper format as Legal.

TABLOID 

specifies the paper format as Tabloid.

USER 

The real paper size is user defined in 100th mm.

enum PaperOrientation
published

specifies the orientation of the paper.

Enumerator
PORTRAIT 

set the paper orientation to portrait.

LANDSCAPE 

set the paper orientation to landscape.

enum PrintableState
published

specifies the print progress of an XPrintable.

Printing consists of two abstract phases: rendering the document for the printer and then sending it to the printer (spooling). PrintableState describes which phase is currently progressing or has failed.

See also
PrintableStateEvent
Enumerator
JOB_STARTED 

printing (rendering the document) has begun

JOB_COMPLETED 

printing (rendering the document) has finished, spooling has begun

JOB_SPOOLED 

spooling has finished successfully.

This is the only state that can be considered as "success" for a print job.

JOB_ABORTED 

printing was aborted (e.g., by the user) while either printing or spooling.

JOB_FAILED 

printing ran into an error.

JOB_SPOOLING_FAILED 

the document could be printed but not spooled.

enum SelectionType
published

Specifies a selection type for a view that supports a selection model.

Enumerator
NONE 

No selection is possible.

The selection is always empty.

SINGLE 

The selection can only contain one or zero objects.

MULTI 

The selection can contain zero or more objects.

RANGE 

The selection can contain zero or more objects.

all selected objects must be part of a continues range