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

kviewshell

GMapRect Class Reference

Implements rectangular map areas. More...

#include <GMapAreas.h>

Inheritance diagram for GMapRect:

Inheritance graph
[legend]

List of all members.


Public Member Functions

virtual GP< GMapArea > get_copy (void) const
int get_height (void) const
virtual MapAreaType const get_shape_type (void) const
int get_width (void) const
virtual GUTF8String get_xmltag (const int height) const
virtual void map (GRectMapper &mapper)
GMapRect & operator= (const GRect &rect)
virtual void unmap (GRectMapper &mapper)
virtual ~GMapRect ()

Static Public Member Functions

static GP< GMapRect > create (const GRect &rect)
static GP< GMapRect > create (void)

Protected Member Functions

virtual bool gma_is_point_inside (const int x, const int y) const
virtual void gma_move (int dx, int dy)
virtual GUTF8String gma_print (void)
virtual void gma_resize (int new_width, int new_height)
virtual void gma_transform (const GRect &grect)
 GMapRect (const GRect &rect)
 GMapRect (void)

Protected Attributes

int xmax
int xmin
int ymax
int ymin

GMapAreas.h

Files #"GMapAreas.h"# and #"GMapAreas.cpp"# implement base objects used by the plugin to display and manage hyperlinks and highlighted areas inside a {DjVuImage} page.

The currently supported areas can be rectangular ({GMapRect}), elliptical ({GMapOval}) and polygonal ({GMapPoly}). Every map area besides the definition of its shape contains information about display style and optional { URL}, which it may refer to. If this { URL} is not empty then the map area will work like a hyperlink.

The classes also implement some useful functions to ease geometry manipulations

Definition of base map area classes

Author:
Andrei Erofeev <eaf@geocities.com>
Version:
$Id: GMapAreas.h,v 1.8 2003/11/07 22:08:21 leonb Exp $#


virtual char const *const gma_check_object (void) const
virtual int gma_get_xmax (void) const
virtual int gma_get_xmin (void) const
virtual int gma_get_ymax (void) const
virtual int gma_get_ymin (void) const
virtual char const *const get_shape_name (void) const
 operator GRect (void)

Detailed Description

Implements rectangular map areas.

This is the only kind of map areas supporting SHADOW_IN_BORDER#, SHADOW_OUT_BORDER#, SHADOW_EIN_BORDER# and SHADOW_EOUT_BORDER# types of border and area highlighting.

Definition at line 290 of file GMapAreas.h.


Constructor & Destructor Documentation

GMapRect::GMapRect ( void   )  [protected]

Definition at line 892 of file GMapAreas.cpp.

GMapRect::GMapRect ( const GRect &  rect  )  [protected]

Definition at line 894 of file GMapAreas.cpp.

GMapRect::~GMapRect (  )  [virtual]

Definition at line 112 of file GMapAreas.cpp.


Member Function Documentation

static GP<GMapRect> GMapRect::create ( const GRect &  rect  )  [inline, static]

Create with the specified GRect.

Definition at line 299 of file GMapAreas.h.

static GP<GMapRect> GMapRect::create ( void   )  [inline, static]

Default creator.

Definition at line 297 of file GMapAreas.h.

GP< GMapArea > GMapRect::get_copy ( void   )  const [virtual]

Returns a copy of the rectangle.

Implements GMapArea.

Definition at line 923 of file GMapAreas.cpp.

int GMapRect::get_height ( void   )  const [inline]

Returns the height of the rectangle.

Definition at line 306 of file GMapAreas.h.

char const *const GMapRect::get_shape_name ( void   )  const [inline, virtual]

Returns #"rect"#.

Implements GMapArea.

Definition at line 512 of file GMapAreas.h.

virtual MapAreaType const GMapRect::get_shape_type ( void   )  const [inline, virtual]

Returns MapRect.

Reimplemented from GMapArea.

Definition at line 316 of file GMapAreas.h.

int GMapRect::get_width ( void   )  const [inline]

Returns the width of the rectangle.

Definition at line 304 of file GMapAreas.h.

GUTF8String GMapRect::get_xmltag ( const int  height  )  const [virtual]

Implements GMapArea.

Definition at line 1012 of file GMapAreas.cpp.

char const *const GMapRect::gma_check_object ( void   )  const [inline, protected, virtual]

Implements GMapArea.

Definition at line 509 of file GMapAreas.h.

int GMapRect::gma_get_xmax ( void   )  const [inline, protected, virtual]

Implements GMapArea.

Definition at line 503 of file GMapAreas.h.

int GMapRect::gma_get_xmin ( void   )  const [inline, protected, virtual]

Implements GMapArea.

Definition at line 497 of file GMapAreas.h.

int GMapRect::gma_get_ymax ( void   )  const [inline, protected, virtual]

Implements GMapArea.

Definition at line 506 of file GMapAreas.h.

int GMapRect::gma_get_ymin ( void   )  const [inline, protected, virtual]

Implements GMapArea.

Definition at line 500 of file GMapAreas.h.

bool GMapRect::gma_is_point_inside ( const int  x,
const int  y 
) const [protected, virtual]

Implements GMapArea.

Definition at line 917 of file GMapAreas.cpp.

void GMapRect::gma_move ( int  dx,
int  dy 
) [protected, virtual]

Implements GMapArea.

Definition at line 908 of file GMapAreas.cpp.

GUTF8String GMapRect::gma_print ( void   )  [protected, virtual]

Implements GMapArea.

Definition at line 406 of file GMapAreas.cpp.

void GMapRect::gma_resize ( int  new_width,
int  new_height 
) [protected, virtual]

Implements GMapArea.

Definition at line 392 of file GMapAreas.cpp.

void GMapRect::gma_transform ( const GRect &  grect  )  [protected, virtual]

Implements GMapArea.

Definition at line 399 of file GMapAreas.cpp.

void GMapRect::map ( GRectMapper &  mapper  )  [virtual]

Virtual function maps rectangle from one area to another using mapper.

Implements GMapArea.

Definition at line 414 of file GMapAreas.cpp.

GMapRect::operator GRect ( void   )  [inline]

Returns {GRect} describing the map area's rectangle.

Definition at line 491 of file GMapAreas.h.

GMapRect & GMapRect::operator= ( const GRect &  rect  ) 

Changes the GMapRect#'s geometry.

Definition at line 898 of file GMapAreas.cpp.

void GMapRect::unmap ( GRectMapper &  mapper  )  [virtual]

Virtual function unmaps rectangle from one area to another using mapper.

Implements GMapArea.

Definition at line 430 of file GMapAreas.cpp.


Member Data Documentation

int GMapRect::xmax [protected]

Reimplemented from GMapArea.

Definition at line 326 of file GMapAreas.h.

int GMapRect::xmin [protected]

Reimplemented from GMapArea.

Definition at line 326 of file GMapAreas.h.

int GMapRect::ymax [protected]

Reimplemented from GMapArea.

Definition at line 326 of file GMapAreas.h.

int GMapRect::ymin [protected]

Reimplemented from GMapArea.

Definition at line 326 of file GMapAreas.h.


The documentation for this class was generated from the following files:
  • GMapAreas.h
  • GMapAreas.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