The Battle for Wesnoth  1.13.4+dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Private Member Functions | Friends | List of all members
gui2::twidget::tvisible Class Reference

Visibility settings done by the user. More...

#include <widget.hpp>

Inheritance diagram for gui2::twidget::tvisible:
Inheritance graph

Public Types

enum  scoped_enum { visible, hidden, invisible }
 

Private Member Functions

 tvisible ()
 

Friends

class tno_such_friend_exists_but_it_makes_the_compiler_happy
 

Detailed Description

Visibility settings done by the user.

Definition at line 61 of file widget.hpp.

Member Enumeration Documentation

Todo:
C++11 use a scoped enum.
Enumerator
visible 

The user sets the widget visible, that means:

  • The widget is visible.
  • find_at always 'sees' the widget (the active flag is tested later).
  • The widget (if active) handles events (and sends events to its children).
  • The widget is drawn (and sends the call to populate_dirty_list to children).
hidden 

The user sets the widget hidden, that means:

  • The widget is invisible but keeps its size.
  • find_at 'sees' the widget if active is false.
  • The widget doesn't handle events (and doesn't send events to its children).
  • The widget doesn't add itself twindow::dirty_list_ when populate_dirty_list is called (nor does it send the request to its children).
invisible 

The user set the widget invisible, that means:

  • The widget is invisible and its grid cell has size 0,0.
  • find_at never 'sees' the widget.
  • The widget doesn't handle events (and doesn't send events to its children).
  • The widget doesn't add itself twindow::dirty_list_ when populate_dirty_list is called (nor does it send the request to its children).

Definition at line 68 of file widget.hpp.

Constructor & Destructor Documentation

gui2::twidget::tvisible::tvisible ( )
private

Friends And Related Function Documentation

friend class tno_such_friend_exists_but_it_makes_the_compiler_happy
friend

Definition at line 63 of file widget.hpp.


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