wex v24.04.0
Public Member Functions | List of all members
wex::statusbar_pane Class Reference

This class defines our statusbar panes, used by wex::frame::setup_statusbar. More...

#include <wex/ui/statusbar-pane.h>

Inherits wxStatusBarPane.

Public Member Functions

 statusbar_pane (int width=-5, int style=wxSB_NORMAL)
 Default constructor.
 
 statusbar_pane (const std::string &name, int width=50, bool show=true)
 Constructor.
 
statusbar_panehelp (const std::string &rhs)
 Sets helptext.
 
const auto & help_text () const
 Returns statusbar pane help text.
 
const auto & hidden_text () const
 Returns hidden text.
 
statusbar_panehidden_text (const std::string &text)
 Sets hidden text.
 
bool is_shown () const
 Returns whether this pane is shown.
 
const auto & name () const
 Returns statusbar pane name.
 
statusbar_paneshow (bool show)
 Sets whether this pane is shown.
 
statusbar_panestyle (int rhs)
 Sets style.
 

Detailed Description

This class defines our statusbar panes, used by wex::frame::setup_statusbar.

It just adds some members to the base class (that offers GetText(), GetStyle() and GetWidth()).

Constructor & Destructor Documentation

◆ statusbar_pane() [1/2]

wex::statusbar_pane::statusbar_pane ( int width = -5,
int style = wxSB_NORMAL )
inline

Default constructor.

This constructs the PaneText pane.

Parameters
widthwidth of the pane (default, might be overridden in the config)
stylestyle (default, might be overridden in the config)

◆ statusbar_pane() [2/2]

wex::statusbar_pane::statusbar_pane ( const std::string & name,
int width = 50,
bool show = true )

Constructor.

Parameters
namename of the pane this lib uses:
  • PaneFileType
  • PaneInfo
  • PaneLexer
  • PaneTheme
  • PaneMacro
  • PaneMode by setting up one of these panes, your panes will get controlled by the lib.
widthwidth of the pane (default, might be overridden in the config)
showshow pane

Member Function Documentation

◆ help()

statusbar_pane & wex::statusbar_pane::help ( const std::string & rhs)

Sets helptext.

helptext shown as a tooltip If you do no provide helptext, it is derived from the name, by using text after the first 'e' character (so after 'Pane').

◆ show()

statusbar_pane & wex::statusbar_pane::show ( bool show)

Sets whether this pane is shown.

Resets the hidden text if show is true.

◆ style()

statusbar_pane & wex::statusbar_pane::style ( int rhs)

Sets style.

style (default, might be overridden in the config)

  • wxSB_NORMAL (0)
  • wxSB_FLAT (1)
  • wxSB_RAISED (2)
  • wxSB_SUNKEN (3)