Public Member Functions | Private Types | Private Member Functions

VehicleViewWindow Struct Reference

Window manager class for viewing a vehicle. More...

Inheritance diagram for VehicleViewWindow:
Window ZeroedMemoryAllocator

Public Member Functions

 VehicleViewWindow (const WindowDesc *desc, WindowNumber window_number)
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 SetStringParameters (int widget) const
 Initialize string parameters for a widget.
virtual void DrawWidget (const Rect &r, int widget) const
 Draw the contents of a nested widget.
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.
virtual void OnTick ()
 Called once per (game) tick.
virtual void OnInvalidateData (int data=0, bool gui_scope=true)
 Some data on this window has become invalid.
virtual bool IsNewGRFInspectable () const
 Is the data related to this window NewGRF inspectable?
virtual void ShowNewGRFInspectWindow () const
 Show the NewGRF inspection window.

Private Types

enum  PlaneSelections {
  SEL_DC_GOTO_DEPOT, SEL_DC_CLONE, SEL_RT_REFIT, SEL_RT_TURN_AROUND,
  SEL_DC_BASEPLANE = SEL_DC_GOTO_DEPOT, SEL_RT_BASEPLANE = SEL_RT_REFIT
}
 

Display planes available in the vehicle view window.

More...

Private Member Functions

void SelectPlane (PlaneSelections plane)
 Display a plane in the window.

Detailed Description

Window manager class for viewing a vehicle.

Definition at line 2286 of file vehicle_gui.cpp.


Member Enumeration Documentation

Display planes available in the vehicle view window.

Enumerator:
SEL_DC_GOTO_DEPOT 

Display 'goto depot' button in VVW_WIDGET_SELECT_DEPOT_CLONE stacked widget.

SEL_DC_CLONE 

Display 'clone vehicle' button in VVW_WIDGET_SELECT_DEPOT_CLONE stacked widget.

SEL_RT_REFIT 

Display 'refit' button in VVW_WIDGET_SELECT_REFIT_TURN stacked widget.

SEL_RT_TURN_AROUND 

Display 'turn around' button in VVW_WIDGET_SELECT_REFIT_TURN stacked widget.

SEL_DC_BASEPLANE 

First plane of the VVW_WIDGET_SELECT_DEPOT_CLONE stacked widget.

SEL_RT_BASEPLANE 

First plane of the VVW_WIDGET_SELECT_REFIT_TURN stacked widget.

Definition at line 2289 of file vehicle_gui.cpp.


Member Function Documentation

virtual void VehicleViewWindow::DrawWidget ( const Rect r,
int  widget 
) const [inline, virtual]
virtual bool VehicleViewWindow::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 2624 of file vehicle_gui.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Get(), GetGrfSpecFeature(), and IsNewGRFInspectable().

virtual void VehicleViewWindow::OnClick ( Point  pt,
int  widget,
int  click_count 
) [inline, virtual]
virtual void VehicleViewWindow::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 2615 of file vehicle_gui.cpp.

virtual void VehicleViewWindow::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 2400 of file vehicle_gui.cpp.

References _local_company, SpecializedVehicle< Train, Type >::From(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Get(), IsVehicleRefitable(), Vehicle::owner, TFP_SIGNAL, BaseVehicle::type, and VEH_TRAIN.

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

Called after the window got resized.

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

Reimplemented from Window.

Definition at line 2577 of file vehicle_gui.cpp.

References NWidgetViewport::UpdateViewportCoordinates().

void VehicleViewWindow::SelectPlane ( PlaneSelections  plane  )  [inline, private]

Display a plane in the window.

Parameters:
plane Plane to show.

Definition at line 2304 of file vehicle_gui.cpp.

References SEL_DC_BASEPLANE, SEL_DC_CLONE, SEL_DC_GOTO_DEPOT, SEL_RT_BASEPLANE, SEL_RT_REFIT, and SEL_RT_TURN_AROUND.

virtual void VehicleViewWindow::SetStringParameters ( int  widget  )  const [inline, virtual]

Initialize string parameters for a widget.

Calls to this function are made during initialization to measure the size (that is as part of InitNested()), during drawing, and while re-initializing the window. Only for widgets that render text initializing is requested.

Parameters:
widget Widget number.

Reimplemented from Window.

Definition at line 2419 of file vehicle_gui.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Get(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem< Tpool >::index, and SetDParam().

virtual void VehicleViewWindow::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 2629 of file vehicle_gui.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Get(), GetGrfSpecFeature(), and ShowNewGRFInspectWindow().

virtual void VehicleViewWindow::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 2382 of file vehicle_gui.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tcache, Tzero >::PoolItem<&_vehicle_pool >::Get(), BaseVehicle::type, VEH_TRAIN, and VVW_WIDGET_VIEWPORT.


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