gemini - kennedy.gemi.dev

💾 Archived View for mirrors.apple2.org.za › archive › apple.cabi.net › Graphics › PICT.and_QT.INFO ›… captured on 2024-05-10 at 15:25:43.
-=-=-=-=-=-=-
#ifndef __PICTDOCUMENT__
#define __PICTDOCUMENT__
/******************************************************************************\

	
	Apple Macintosh Developer Technical Support
	
	Header file for the Picture Document routines
	
	Program: ColorReset
	File:    PictDocument.h
	
	by:      Forrest Tanaka
	
	Copyright � 1988-1992 Apple Computer, Inc.
	All rights reserved.
	

\******************************************************************************/

#ifndef THINK_C
#ifndef __WINDOWS__
#include <Windows.h>
#endif

#ifndef __FILES__
#include <Files.h>
#endif
#endif

/******************************************************************************\

	NAME & SYNOPSIS:
	FindPictDoc: Find the Picture Document window for a specific file
	
	PARAMETERS:
	FSSpecPtr fileSpec: Specification of file to search for
	
	DEFINITION:
	FindPictDoc finds the Picture Document window associated with the file
	specified by fileSpec.  A pointer to this window is returned.  If no matching
	Picture Document window could be found, then nil is returned.
	
	RETURN VALUES:
	Result: Pointer to the Picture Document window that�s associated with the file
	that�s specified by the fileSpec parameter.

\******************************************************************************/

WindowPtr FindPictDoc(
	FSSpecPtr fileSpec);


/******************************************************************************\

	NAME & SYNOPSIS:
	NextPictDocWindow: Return a pointer to the next Picture Document window
	
	PARAMETERS:
	WindowPtr aWindow: Window to start search from, or nil if want front-most
	
	DEFINITION:
	This routine returns a pointer to the first Picture Document window in the
	window list AFTER the window specified by aWindow.  If aWindow is nil, then
	NextPictDocWindow returns a pointer to the first Picture Document window in
	the window list (ie the front-most Picture Document window.  If no Picture 
	Document windows could be found, then nil is returned.
	
	RETURN VALUES:
	Result: Pointer to the Picture Document window that�s after the window that�s
	specified by the aWindow parameter.  If aWindow is nil, a pointer to
	the front-most Picture Document window is returned.

\******************************************************************************/

WindowPtr NextPictDocWindow(
	WindowPtr aWindow);


/******************************************************************************\

	NAME & SYNOPSIS:
	IsPictDocWindow: Is a window a Picture Document window?
	
	PARAMETERS:
	WindowPtr aWindow: Window to test for Picture Document-ness
	
	DEFINITION:
	When it needs to be determined whether a window is a Picture Document window
	or not, this routine is called.  It returns true if aWindow is a Picture
	Document window, or false if not.  If aWindow is nil, then false is returned.
	
	RETURN VALUES:
	Result: Boolean true if the aWindow parameter refers to a Picture Document
	window; false if not.

\******************************************************************************/

Boolean IsPictDocWindow(
	WindowPtr aWindow);


/******************************************************************************\

	NAME & SYNOPSIS:
	DrawPictDoc: Draw the contents of a Picture Document
	
	PARAMETERS:
	WindowPtr docWindow: Ptr to Picture Document window being drawn
	
	DEFINITION:
	The contents of the Picture Document window specified by docWindow are
	drawn into the window.  The contents include the image, the scroll bars, and
	the grow icon.  This routine is called in response to update events.
	
	RETURN VALUES:
	None

\******************************************************************************/

void DrawPictDoc(
	WindowPtr docWindow);


/******************************************************************************\

	NAME & SYNOPSIS:
	ClickPictDoc: Handle a mouse click in a Picture Document window
	
	PARAMETERS:
	WindowPtr   docWindow:   Pointer to Picture Document window that was clicked
	EventRecord *clickEvent: Event that recorded the mouse click
	
	DEFINITION:
	Whenever there�s a mouse-down event in a Picture Document window, this routine
	is called to handle the mouse click.  There are two cases in which there can
	be a mouse click in a Picture Document window and ClickPictDoc is not called:
	if the title bar of a window is clicked, DoWindowDrag in ColorReset.c is
	called to let the user move the window; if the grow icon is clicked,
	GrowPictDoc, defined below, is called to let the user change the size of the
	window.
	
	ClickPictDoc handles mouse clicks in the image within the Picture Document
	window by letting the user draw paint into the image.  Clicks in either of the
	two scroll bars are handled by scrolling the image in the way that the user
	wants.
	
	RETURN VALUES:
	None

\******************************************************************************/

void ClickPictDoc(
	WindowPtr   docWindow,
	EventRecord *clickEvent);


/******************************************************************************\

	NAME & SYNOPSIS:
	GrowPictDoc: Let the user change the size of a Picture Document window
	
	PARAMETERS:
	WindowPtr   docWindow:   Picture Document window that�s to be grown
	EventRecord *clickEvent: Mouse down event
	
	DEFINITION:
	GrowPictDoc is called whenever there�s a click in the grow icon of a Picture
	Document window.  It lets the user grow and shrink the window until he or she
	lets go of the mouse button.  The Picture Document window is then updated for
	the new size of the window.
	
	DESCRIPTION:
	GrowWindow is called with a boundary rectangle that specifies that the window
	has a minimum size of kMinWindowSize (defined at the top of this source file)
	and a maximum size that�s the size of the image.  After the user releases the
	mouse button, SizeWindow is called to change the size of the window, and
	ResizePictDoc (defined below) is called to update the Picture Document to the
	new size.
	
	RETURN VALUES:
	None

\******************************************************************************/

void GrowPictDoc(
	WindowPtr   docWindow,
	EventRecord *clickEvent);


/******************************************************************************\

	NAME & SYNOPSIS:
	ActivatePictDoc: Activate or deactivate a Picture Document window
	
	PARAMETERS:
	WindowPtr docWindow:      Picture Document window that�s being (de)activated
	Boolean   becomingActive: True if window is becoming active; false otherwise
	
	DEFINITION:
	ActivatePictDoc is called whenever a Picture Document window is activated or
	deactivated.  This is just to handle the visual aspects of window activation,
	such as hiding or showing the grow icon and the scroll bars.
	
	RETURN VALUES:
	None

\******************************************************************************/

void ActivatePictDoc(
	WindowPtr docWindow,
	Boolean   becomingActive);


/******************************************************************************\

	NAME & SYNOPSIS:
	FixPictDocMenus: Enable or check menus for Picture Documents
	
	PARAMETERS:
	WindowPtr docWindow: Picture Document to apply menu dimming to
	
	DEFINITION:
	FixPictDocMenus is called whenever the state of the menus associated with a
	Picture Document window is changed, like when a Picture Document is opened, or
	if some state of the Picture Document has changed.  FixPictDocMenus only
	enables or checks menu items; it doesn�t disable or uncheck items.  Disabling
	and unchecking is handled in MenuHandler.c.
	
	RETURN VALUES:
	None

\******************************************************************************/

void FixPictDocMenus(
	WindowPtr docWindow);


/******************************************************************************\

	NAME & SYNOPSIS:
	DoOpenPictDoc: Open a new Picture Document
	
	PARAMETERS:
	None
	
	DEFINITION:
	When the user chooses Open� from the file menu to open an existing Picture
	Document file (really a PICT file).  The user is asked which PICT file to
	open, and then a new window appears with the picture displayed in it.  A
	pointer to this window is returned.  If the Picture Document couldn�t be
	opened for some reason, an alert is displayed which tells the user what went
	wrong, and no Picture Document window is opened.
	
	If the Picture Document is already open from another application, then it
	can�t be opened from this application, and an alert is given to the user.  If
	the Picture Document is already open within this application, then that
	document�s window is simply activated and its pointer is returned.
	
	RETURN VALUES:
	Result: Pointer to the new Picture Document window.  If a Picture Document
	window couldn�t be created, nil is returned.

\******************************************************************************/

WindowPtr DoOpenPictDoc(void);


/******************************************************************************\

	NAME & SYNOPSIS:
	DoSaveAsPictDoc: Save a new Picture Document
	
	PARAMETERS:
	WindowPtr docWindow: Pointer to Picture Document window being saved
	
	DEFINITION:
	This routine is called when the user chooses Save As� from the File menu.  It
	saves a new Picture Document as a PICT file.
	
	RETURN VALUES:
	None

\******************************************************************************/

void DoSaveAsPictDoc(
	WindowPtr docWindow);


/******************************************************************************\

	NAME & SYNOPSIS:
	DoClosePictDoc: Close a Picture Document window
	
	PARAMETERS:
	WindowPtr docWindow: Pointer to Picture Document window being closed
	
	DEFINITION:
	This routine closes the Picture Document window specified by the
	docWindow parameter.  All memory associated with the window is disposed
	of and the window is closed.  At this time, true is always returned.
	
	RETURN VALUES:
	Result: Always true

\******************************************************************************/

Boolean DoClosePictDoc(
	WindowPtr docWindow);


/******************************************************************************\

	NAME & SYNOPSIS:
	ChooseBrushColor: Choose a color for the brush
	
	PARAMETERS:
	WindowPtr docWindow: Window whose brush color is to be chosen
	
	DEFINITION:
	When the user chooses Brush Color��from the Color menu, this routine is called
	to present the Color Picker to the user so that he or she can choose a new
	color for the brush.
	
	RETURN VALUES:
	None

\******************************************************************************/

void ChooseBrushColor(
	WindowPtr docWindow);


#endif