wex v24.10.0
Classes | Public Types | Public Member Functions | List of all members
wex::data::stc Class Reference

Offers user data to be used by stc. More...

#include <wex/data/stc.h>

Classes

class  event_data
 Support class for client data stored at the event. More...
 

Public Types

enum  {
  MENU_CONTEXT = 0 , MENU_OPEN_LINK , MENU_OPEN_WWW , MENU_VCS ,
  MENU_DEBUG
}
 Menu and tooltip flags. More...
 
enum  {
  WIN_READ_ONLY = 0 , WIN_HEX , WIN_NO_INDICATOR , WIN_IS_PROJECT ,
  WIN_EX , WIN_SINGLE_LINE
}
 Window flags. More...
 
enum  indicator_t { IND_LINE = 0 , IND_ERR , IND_DEBUG }
 Indicator type. More...
 
typedef std::bitset< 5 > menu_t
 A typedef containing menu flags.
 
typedef std::bitset< 6 > window_t
 A typedef containing window flags.
 

Public Member Functions

 stc ()
 Default constructor.
 
 stc (const data::control &data)
 Constructor from control data.
 
 stc (const data::window &data)
 Constructor from window data.
 
auto & control () const
 Returns control data.
 
auto & control ()
 Returns (or sets) control data.
 
stccontrol (const data::control &data)
 Sets control data.
 
const auto & event () const
 Returns event data.
 
stcevent (bool synced)
 Sets event data.
 
const auto & flags () const
 Returns window flags.
 
stcflags (window_t flags, data::control::action_t action=data::control::SET)
 Set window flags.
 
auto * get_stc ()
 Returns stc.
 
const auto & head_path () const
 Returns head path.
 
stchead_path (const path &r)
 Sets head path.
 
const auto indicator_no () const
 Returns indicator type.
 
stcindicator_no (indicator_t t)
 Sets indicator type.
 
bool inject () const
 injects data.
 
const auto & menu () const
 Returns menu flags.
 
stcmenu (menu_t flags, data::control::action_t action=data::control::SET)
 Sets menu flags.
 
bool recent () const
 Returns whether recent is on, for allowing set_recent_file.
 
stcrecent (bool recent)
 Sets recent.
 
stcset_stc (syntax::stc *rhs)
 Sets stc.
 
const auto & window () const
 Returns window data.
 
stcwindow (const data::window &data)
 Sets window data.
 

Detailed Description

Offers user data to be used by stc.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Menu and tooltip flags.

Enumerator
MENU_CONTEXT 

context menu

MENU_OPEN_LINK 

for adding link open menu

MENU_OPEN_WWW 

for adding search on www open menu

MENU_VCS 

for adding vcs menu

MENU_DEBUG 

for adding debug menu

◆ anonymous enum

anonymous enum

Window flags.

Enumerator
WIN_READ_ONLY 

window is readonly, overrides real mode from disk

WIN_HEX 

window in hex mode

WIN_NO_INDICATOR 

a change indicator is not used

WIN_IS_PROJECT 

open as project

WIN_EX 

window in ex mode, instead of vi

WIN_SINGLE_LINE 

window has only a single line

◆ indicator_t

Indicator type.

Enumerator
IND_LINE 

line indicator

IND_ERR 

error indicator

IND_DEBUG 

debug indicator