MessageHistoryWindow Struct Reference

Inheritance diagram for MessageHistoryWindow:
Window ZeroedMemoryAllocator

Public Member Functions

 MessageHistoryWindow (const WindowDesc *desc)
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.
virtual void OnPaint ()
 The window must be repainted.
virtual void DrawWidget (const Rect &r, int widget) const
 Draw the contents of a nested widget.
virtual void OnInvalidateData (int data)
 Some data on this window has become invalid.
virtual void OnClick (Point pt, int widget, int click_count)
 A click with the left mouse button has been made on the window.
virtual void OnResize ()
 Called after the window got resized.

Data Fields

int line_height
int date_width
 < Height of a single line in the news histoy window including spacing.
Scrollbarvscroll
 < Width needed for the date part.

Static Public Attributes

static const int top_spacing = WD_FRAMERECT_TOP + 4
 Additional spacing at the top of the MHW_BACKGROUND widget.
static const int bottom_spacing = WD_FRAMERECT_BOTTOM
 Additional spacing at the bottom of the MHW_BACKGROUND widget.

Detailed Description

Definition at line 947 of file news_gui.cpp.


Member Function Documentation

virtual void MessageHistoryWindow::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 984 of file news_gui.cpp.

References _current_text_dir, _total_news, NewsItem::date, date_width, DrawNewsString(), DrawString(), Scrollbar::GetCapacity(), Scrollbar::GetPosition(), NewsItem::prev, SetDParam(), TD_RTL, top_spacing, vscroll, WD_FRAMERECT_LEFT, and WD_FRAMERECT_RIGHT.

virtual void MessageHistoryWindow::OnClick ( Point  pt,
int  widget,
int  click_count 
) [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.
click_count Number of fast consecutive clicks at same position

Reimplemented from Window.

Definition at line 1019 of file news_gui.cpp.

References Scrollbar::GetScrolledRowFromWidget(), NewsItem::prev, ShowNewsMessage(), vscroll, and WD_FRAMERECT_TOP.

virtual void MessageHistoryWindow::OnInvalidateData ( int  data  )  [inline, virtual]

Some data on this window has become invalid.

Parameters:
data information about the changed data.

Reimplemented from Window.

Definition at line 1014 of file news_gui.cpp.

References _total_news, Scrollbar::SetCount(), and vscroll.

Referenced by OnPaint().

virtual void MessageHistoryWindow::OnPaint (  )  [inline, virtual]

The window must be repainted.

Note:
This method should not change any state, it should only use drawing functions.

Reimplemented from Window.

Definition at line 978 of file news_gui.cpp.

References Window::DrawWidgets(), and OnInvalidateData().

virtual void MessageHistoryWindow::OnResize (  )  [inline, virtual]

Called after the window got resized.

For nested windows with a viewport, call NWidgetViewport::UpdateViewportCoordinates.

Reimplemented from Window.

Definition at line 1034 of file news_gui.cpp.

References Scrollbar::SetCapacity(), and vscroll.

virtual void MessageHistoryWindow::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 964 of file news_gui.cpp.

References bottom_spacing, ConvertYMDToDate(), date_width, FONT_HEIGHT_NORMAL, GetStringBoundingBox(), max(), ORIGINAL_MAX_YEAR, SetDParam(), and top_spacing.


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

Generated on Fri Dec 31 17:16:35 2010 for OpenTTD by  doxygen 1.6.1