LandInfoWindow Class Reference

Inheritance diagram for LandInfoWindow:
Window ZeroedMemoryAllocator

Public Member Functions

virtual void DrawWidget (const Rect &r, int widget) const
 Draw the contents of a nested widget.
virtual void UpdateWidgetSize (int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
 Update size and resize step of a widget in the window.
 LandInfoWindow (TileIndex tile)
virtual void OnInit ()
 Notification that the nested widget tree gets initialized.
virtual bool IsNewGRFInspectable () const
 Is the data related to this window NewGRF inspectable?
virtual void ShowNewGRFInspectWindow () const
 Show the NewGRF inspection window.
virtual void OnInvalidateData (int data=0, bool gui_scope=true)
 Some data on this window has become invalid.

Data Fields

char landinfo_data [LAND_INFO_LINE_END][LAND_INFO_LINE_BUFF_SIZE]
TileIndex tile

Private Types

enum  LandInfoLines { LAND_INFO_CENTERED_LINES = 12, LAND_INFO_MULTICENTER_LINE = LAND_INFO_CENTERED_LINES, LAND_INFO_LINE_END }

Static Private Attributes

static const uint LAND_INFO_LINE_BUFF_SIZE = 512

Detailed Description

Definition at line 68 of file misc_gui.cpp.


Member Enumeration Documentation

Enumerator:
LAND_INFO_CENTERED_LINES 

Up to 12 centered lines.

LAND_INFO_MULTICENTER_LINE 

One multicenter line.

Definition at line 69 of file misc_gui.cpp.


Member Function Documentation

virtual void LandInfoWindow::DrawWidget ( const Rect r,
int  widget 
) const [inline, virtual]

Draw the contents of a nested widget.

Parameters:
r Rectangle occupied by the widget.
widget Number of the widget to draw.
Note:
This method may not change any state, it may only use drawing functions.

Reimplemented from Window.

Definition at line 81 of file misc_gui.cpp.

References DrawString(), DrawStringMultiLine(), FONT_HEIGHT_NORMAL, LAND_INFO_CENTERED_LINES, LAND_INFO_MULTICENTER_LINE, LIW_BACKGROUND, SA_CENTER, SA_HOR_CENTER, SetDParamStr(), StrEmpty(), WD_FRAMETEXT_LEFT, WD_FRAMETEXT_RIGHT, WD_PAR_VSEP_NORMAL, WD_TEXTPANEL_BOTTOM, and WD_TEXTPANEL_TOP.

virtual bool LandInfoWindow::IsNewGRFInspectable (  )  const [inline, virtual]

Is the data related to this window NewGRF inspectable?

Returns:
true iff it is inspectable.

Reimplemented from Window.

Definition at line 324 of file misc_gui.cpp.

References GetGrfSpecFeature().

virtual void LandInfoWindow::OnInit (  )  [inline, virtual]
virtual void LandInfoWindow::OnInvalidateData ( int  data = 0,
bool  gui_scope = true 
) [inline, virtual]

Some data on this window has become invalid.

Parameters:
data Information about the changed data.
gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See InvalidateWindowData() for details.

Reimplemented from Window.

Definition at line 339 of file misc_gui.cpp.

References Window::ReInit().

virtual void LandInfoWindow::ShowNewGRFInspectWindow (  )  const [inline, virtual]

Show the NewGRF inspection window.

When this function is called it is up to the window to call and pass the right parameters to the ShowInspectWindow function.

Precondition:
this->IsNewGRFInspectable()

Reimplemented from Window.

Definition at line 329 of file misc_gui.cpp.

References GetGrfSpecFeature().

virtual void LandInfoWindow::UpdateWidgetSize ( int  widget,
Dimension size,
const Dimension padding,
Dimension fill,
Dimension resize 
) [inline, virtual]

Update size and resize step of a widget in the window.

After retrieval of the minimal size and the resize-steps of a widget, this function is called to allow further refinement, typically by computing the real maximal size of the content. Afterwards, size is taken to be the minimal size of the widget and resize is taken to contain the resize steps. For the convenience of the callee, padding contains the amount of padding between the content and the edge of the widget. This should be added to the returned size.

Parameters:
widget Widget number.
size Size of the widget.
padding Recommended amount of space between the widget content and the widget edge.
fill Fill step of the widget.
resize Resize step of the widget.

Reimplemented from Window.

Definition at line 100 of file misc_gui.cpp.

References FONT_HEIGHT_NORMAL, GetStringBoundingBox(), GetStringHeight(), LAND_INFO_CENTERED_LINES, LAND_INFO_MULTICENTER_LINE, LIW_BACKGROUND, max(), min(), SetDParamStr(), StrEmpty(), WD_FRAMETEXT_LEFT, WD_FRAMETEXT_RIGHT, WD_PAR_VSEP_NORMAL, WD_TEXTPANEL_BOTTOM, WD_TEXTPANEL_TOP, and Window::width.


The documentation for this class was generated from the following file:

Generated on Thu Apr 14 00:49:09 2011 for OpenTTD by  doxygen 1.6.1