Main Page   Data Structures   File List   Data Fields   Globals   Related Pages  

palm/minimap.h File Reference

#include <PalmTypes.h>
#include <Rect.h>
#include <sections.h>

Go to the source code of this file.

Functions

Int8 minimapGetShowing (void)
 is the minimap showing

void minimapSetShowing (Int8 show) MINIMAP_SECTION
 set whether the minimap is showing

Int8 minimapGetDetailed (void)
 get the detailed flag (fast devices can render details)

void minimapSetDetailed (Int8 detailed) MINIMAP_SECTION
 set detailed flag for minimap

void minimapPlace (RectangleType *pos)
 set the location of the minimap on the display

void minimapPaint (void)
 paint the minimap if it is visible on the screen

Int8 minimapIsTapped (PointType *point, PointType *percentage)
 check if the minimap is tapped, returning the age on each axis

void minimapIntersect (const RectangleType *other, RectangleType *dest)
 get the intersection of the other rectangle and the dest rectangle


Detailed Description

interface to the minimap

Definition in file minimap.h.


Function Documentation

Int8 minimapGetDetailed (  void    ) 
 

get the detailed flag (fast devices can render details)

Returns:
whether detailed minimaps are shown

Definition at line 38 of file minimap.c.

Int8 minimapGetShowing (  void    ) 
 

is the minimap showing

Returns:
true if the minimap is showing

Definition at line 26 of file minimap.c.

void minimapIntersect (  const RectangleType *    other,
RectangleType *    dest
) 
 

get the intersection of the other rectangle and the dest rectangle

Parameters:
other  the other rectangle (usually the play area)
dest  the overlap rectangle

Definition at line 63 of file minimap.c.

Referenced by UIScrollDisplay().

Int8 minimapIsTapped (  PointType *    point,
PointType *    percentage
) 
 

check if the minimap is tapped, returning the age on each axis

Parameters:
point  the point to test
percentage  the percentages on the x and y axis
Returns:
non-zero if the map has been tapped, zero otherwise.

Definition at line 86 of file minimap.c.

void minimapPlace (  RectangleType *    pos ) 
 

set the location of the minimap on the display

Parameters:
pos  the position and size of the minimap

Definition at line 50 of file minimap.c.

References getMapHeight, and getMapWidth.

void minimapSetDetailed (  Int8    detailed ) 
 

set detailed flag for minimap

Parameters:
detailed  the new setting for the detailed map

Definition at line 44 of file minimap.c.

References Int8.

void minimapSetShowing (  Int8    show ) 
 

set whether the minimap is showing

Parameters:
show  set whether it is showing or not

Definition at line 32 of file minimap.c.

References Int8.


Generated on Mon Aug 30 19:44:17 2004 for pocketcity by doxygen1.2.18