BuildTreesWindow Class Reference

Inheritance diagram for BuildTreesWindow:


Public Member Functions
	BuildTreesWindow (const WindowDesc *desc, WindowNumber window_number)
virtual void	OnPaint ()
	This window is currently being repainted.
virtual void	OnClick (Point pt, int widget)
	A click with the left mouse button has been made on the window.
virtual void	OnPlaceObject (Point pt, TileIndex tile)
	The user clicked some place on the map when a tile highlight mode has been set.
virtual void	OnPlaceDrag (ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt)
	The user is dragging over the map when the tile highlight mode has been set.
virtual void	OnPlaceMouseUp (ViewportPlaceMethod select_method, ViewportDragDropSelectionProcess select_proc, Point pt, TileIndex start_tile, TileIndex end_tile)
	The user has dragged over the map when the tile highlight mode has been set.
virtual void	OnTimeout ()
	Called when this window's timeout has been reached.
virtual void	OnPlaceObjectAbort ()
	The user cancelled a tile highlight mode that has been set.
Private Types
	BTW_CLOSE
	BTW_CAPTION
	BTW_BACKGROUND
	BTW_TYPE_11
	BTW_TYPE_12
	BTW_TYPE_13
	BTW_TYPE_14
	BTW_TYPE_21
	BTW_TYPE_22
	BTW_TYPE_23
	BTW_TYPE_24
	BTW_TYPE_31
	BTW_TYPE_32
	BTW_TYPE_33
	BTW_TYPE_34
	BTW_TYPE_RANDOM
	BTW_MANY_RANDOM
enum	BuildTreesWidgets { BTW_CLOSE, BTW_CAPTION, BTW_BACKGROUND, BTW_TYPE_11, BTW_TYPE_12, BTW_TYPE_13, BTW_TYPE_14, BTW_TYPE_21, BTW_TYPE_22, BTW_TYPE_23, BTW_TYPE_24, BTW_TYPE_31, BTW_TYPE_32, BTW_TYPE_33, BTW_TYPE_34, BTW_TYPE_RANDOM, BTW_MANY_RANDOM }
Private Attributes
uint16	base
uint16	count
int	tree_to_plant

Detailed Description

Definition at line 22 of file tree_gui.cpp.

Member Function Documentation

virtual void BuildTreesWindow::OnClick	(	Point	pt,
		int	widget
	)			`[inline, virtual]`

A click with the left mouse button has been made on the window.

Parameters:

	pt	the point inside the window that has been clicked.
	widget	the clicked widget.

Reimplemented from Window.

Definition at line 93 of file tree_gui.cpp.

References base, Window::flags4, HandlePlacePushButton(), Window::LowerWidget(), MarkWholeScreenDirty(), PlaceTreesRandomly(), SndPlayFx(), tree_to_plant, VHM_RECT, and WF_TIMEOUT_SHL.

virtual void BuildTreesWindow::OnPlaceDrag	(	ViewportPlaceMethod	select_method,
		ViewportDragDropSelectionProcess	select_proc,
		Point	pt
	)			`[inline, virtual]`

The user is dragging over the map when the tile highlight mode has been set.

Parameters:

	select_method	the method of selection (allowed directions)
	select_proc	what will be created when the drag is over.
	pt	the exact point on the map where the mouse is.

Reimplemented from Window.

Definition at line 128 of file tree_gui.cpp.

References VpSelectTilesWithMethod(), Point::x, and Point::y.

virtual void BuildTreesWindow::OnPlaceMouseUp	(	ViewportPlaceMethod	select_method,
		ViewportDragDropSelectionProcess	select_proc,
		Point	pt,
		TileIndex	start_tile,
		TileIndex	end_tile
	)			`[inline, virtual]`

The user has dragged over the map when the tile highlight mode has been set.

Parameters:

	select_method	the method of selection (allowed directions)
	select_proc	what should be created.
	pt	the exact point on the map where the mouse was released.
	start_tile	the begin tile of the drag.
	end_tile	the end tile of the drag.