KiCad Pcbnew Python Scripting
All Classes Namespaces Files Functions Variables Properties
Public Member Functions | Properties | List of all members
pcbnew.string Class Reference
Inheritance diagram for pcbnew.string:
Inheritance graph
[legend]

Public Member Functions

def length (self)
 
def max_size (self)
 
def capacity (self)
 
def reserve (self, __res_arg=0)
 
def copy (self, __s, __n, __pos=0)
 
def c_str (self)
 
def find (self, *args)
 
def rfind (self, *args)
 
def find_first_of (self, *args)
 
def find_last_of (self, *args)
 
def find_first_not_of (self, *args)
 
def find_last_not_of (self, *args)
 
def substr (self, *args)
 
def empty (self)
 
def size (self)
 
def swap (self, v)
 
def begin (self)
 
def end (self)
 
def rbegin (self)
 
def rend (self)
 
def get_allocator (self)
 
def erase (self, *args)
 
def __init__ (self, *args)
 
def assign (self, *args)
 
def resize (self, *args)
 
def iterator (self)
 
def __iter__ (self)
 
def __nonzero__ (self)
 
def __bool__ (self)
 
def __len__ (self)
 
def __getslice__ (self, i, j)
 
def __setslice__ (self, *args)
 
def __delslice__ (self, i, j)
 
def __delitem__ (self, *args)
 
def __getitem__ (self, *args)
 
def __setitem__ (self, *args)
 
def insert (self, *args)
 
def replace (self, *args)
 
def __iadd__ (self, v)
 
def __add__ (self, v)
 
def __radd__ (self, v)
 
def __str__ (self)
 
def __rlshift__ (self, out)
 
def __eq__ (self, v)
 
def __ne__ (self, v)
 
def __gt__ (self, v)
 
def __lt__ (self, v)
 
def __ge__ (self, v)
 
def __le__ (self, v)
 

Properties

 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 

Detailed Description

Proxy of C++ std::basic_string< char > class.

Definition at line 146 of file pcbnew.py.

Constructor & Destructor Documentation

◆ __init__()

def pcbnew.string.__init__ (   self,
args 
)
    __init__(string self, char const * __s, std::basic_string< char >::size_type __n) -> string
    __init__(string self) -> string
    __init__(string self, string other) -> string
    __init__(string self, std::basic_string< char >::size_type size, std::basic_string< char >::value_type value) -> string

Definition at line 268 of file pcbnew.py.

Here is the caller graph for this function:

Member Function Documentation

◆ __add__()

def pcbnew.string.__add__ (   self,
  v 
)
__add__(string self, string v) -> string

Definition at line 378 of file pcbnew.py.

◆ __bool__()

def pcbnew.string.__bool__ (   self)
__bool__(string self) -> bool

Definition at line 303 of file pcbnew.py.

◆ __delitem__()

def pcbnew.string.__delitem__ (   self,
args 
)
    __delitem__(string self, std::basic_string< char >::difference_type i)
    __delitem__(string self, PySliceObject * slice)

Definition at line 326 of file pcbnew.py.

Here is the caller graph for this function:

◆ __delslice__()

def pcbnew.string.__delslice__ (   self,
  i,
  j 
)
__delslice__(string self, std::basic_string< char >::difference_type i, std::basic_string< char >::difference_type j)

Definition at line 322 of file pcbnew.py.

◆ __eq__()

def pcbnew.string.__eq__ (   self,
  v 
)
__eq__(string self, string v) -> bool

Definition at line 394 of file pcbnew.py.

◆ __ge__()

def pcbnew.string.__ge__ (   self,
  v 
)
__ge__(string self, string v) -> bool

Definition at line 410 of file pcbnew.py.

◆ __getitem__()

def pcbnew.string.__getitem__ (   self,
args 
)
    __getitem__(string self, PySliceObject * slice) -> string
    __getitem__(string self, std::basic_string< char >::difference_type i) -> std::basic_string< char >::value_type

Definition at line 333 of file pcbnew.py.

Here is the caller graph for this function:

◆ __getslice__()

def pcbnew.string.__getslice__ (   self,
  i,
  j 
)
__getslice__(string self, std::basic_string< char >::difference_type i, std::basic_string< char >::difference_type j) -> string

Definition at line 311 of file pcbnew.py.

◆ __gt__()

def pcbnew.string.__gt__ (   self,
  v 
)
__gt__(string self, string v) -> bool

Definition at line 402 of file pcbnew.py.

◆ __iadd__()

def pcbnew.string.__iadd__ (   self,
  v 
)
__iadd__(string self, string v) -> string

Definition at line 374 of file pcbnew.py.

◆ __iter__()

def pcbnew.string.__iter__ (   self)

Definition at line 296 of file pcbnew.py.

◆ __le__()

def pcbnew.string.__le__ (   self,
  v 
)
__le__(string self, string v) -> bool

Definition at line 414 of file pcbnew.py.

◆ __len__()

def pcbnew.string.__len__ (   self)
__len__(string self) -> std::basic_string< char >::size_type

Definition at line 307 of file pcbnew.py.

◆ __lt__()

def pcbnew.string.__lt__ (   self,
  v 
)
__lt__(string self, string v) -> bool

Definition at line 406 of file pcbnew.py.

◆ __ne__()

def pcbnew.string.__ne__ (   self,
  v 
)
__ne__(string self, string v) -> bool

Definition at line 398 of file pcbnew.py.

◆ __nonzero__()

def pcbnew.string.__nonzero__ (   self)
__nonzero__(string self) -> bool

Definition at line 299 of file pcbnew.py.

◆ __radd__()

def pcbnew.string.__radd__ (   self,
  v 
)
__radd__(string self, string v) -> string

Definition at line 382 of file pcbnew.py.

◆ __rlshift__()

def pcbnew.string.__rlshift__ (   self,
  out 
)
__rlshift__(string self, std::basic_ostream< char,std::char_traits< char > > & out) -> std::basic_ostream< char,std::char_traits< char > > &

Definition at line 390 of file pcbnew.py.

◆ __setitem__()

def pcbnew.string.__setitem__ (   self,
args 
)
    __setitem__(string self, PySliceObject * slice, string v)
    __setitem__(string self, PySliceObject * slice)
    __setitem__(string self, std::basic_string< char >::difference_type i, std::basic_string< char >::value_type x)

Definition at line 340 of file pcbnew.py.

Here is the caller graph for this function:

◆ __setslice__()

def pcbnew.string.__setslice__ (   self,
args 
)
    __setslice__(string self, std::basic_string< char >::difference_type i, std::basic_string< char >::difference_type j)
    __setslice__(string self, std::basic_string< char >::difference_type i, std::basic_string< char >::difference_type j, string v)

Definition at line 315 of file pcbnew.py.

Here is the caller graph for this function:

◆ __str__()

def pcbnew.string.__str__ (   self)
__str__(string self) -> string

Definition at line 386 of file pcbnew.py.

Here is the caller graph for this function:

◆ assign()

def pcbnew.string.assign (   self,
args 
)
    assign(string self, string __str) -> string
    assign(string self, string __str, std::basic_string< char >::size_type __pos, std::basic_string< char >::size_type __n) -> string
    assign(string self, char const * __s, std::basic_string< char >::size_type __n) -> string
    assign(string self, std::basic_string< char >::size_type n, std::basic_string< char >::value_type x)

Definition at line 277 of file pcbnew.py.

Here is the caller graph for this function:

◆ begin()

def pcbnew.string.begin (   self)
begin(string self) -> std::basic_string< char >::iterator

Definition at line 240 of file pcbnew.py.

◆ c_str()

def pcbnew.string.c_str (   self)
c_str(string self) -> char const *

Definition at line 172 of file pcbnew.py.

◆ capacity()

def pcbnew.string.capacity (   self)
capacity(string self) -> std::basic_string< char >::size_type

Definition at line 160 of file pcbnew.py.

◆ copy()

def pcbnew.string.copy (   self,
  __s,
  __n,
  __pos = 0 
)
copy(string self, char * __s, std::basic_string< char >::size_type __n, std::basic_string< char >::size_type __pos=0) -> std::basic_string< char >::size_type

Definition at line 168 of file pcbnew.py.

◆ empty()

def pcbnew.string.empty (   self)
empty(string self) -> bool

Definition at line 228 of file pcbnew.py.

◆ end()

def pcbnew.string.end (   self)
end(string self) -> std::basic_string< char >::iterator

Definition at line 244 of file pcbnew.py.

◆ erase()

def pcbnew.string.erase (   self,
args 
)
    erase(string self, std::basic_string< char >::size_type __pos=0, std::basic_string< char >::size_type __n=std::basic_string< char >::npos) -> string
    erase(string self, std::basic_string< char >::iterator pos) -> std::basic_string< char >::iterator
    erase(string self, std::basic_string< char >::iterator first, std::basic_string< char >::iterator last) -> std::basic_string< char >::iterator

Definition at line 260 of file pcbnew.py.

Here is the caller graph for this function:

◆ find()

def pcbnew.string.find (   self,
args 
)
    find(string self, char const * __s, std::basic_string< char >::size_type __pos, std::basic_string< char >::size_type __n) -> std::basic_string< char >::size_type
    find(string self, string __str, std::basic_string< char >::size_type __pos=0) -> std::basic_string< char >::size_type
    find(string self, char __c, std::basic_string< char >::size_type __pos=0) -> std::basic_string< char >::size_type

Definition at line 176 of file pcbnew.py.

Here is the caller graph for this function:

◆ find_first_not_of()

def pcbnew.string.find_first_not_of (   self,
args 
)
    find_first_not_of(string self, string __str, std::basic_string< char >::size_type __pos=0) -> std::basic_string< char >::size_type
    find_first_not_of(string self, char const * __s, std::basic_string< char >::size_type __pos, std::basic_string< char >::size_type __n) -> std::basic_string< char >::size_type
    find_first_not_of(string self, char __c, std::basic_string< char >::size_type __pos=0) -> std::basic_string< char >::size_type

Definition at line 208 of file pcbnew.py.

Here is the caller graph for this function:

◆ find_first_of()

def pcbnew.string.find_first_of (   self,
args 
)
    find_first_of(string self, string __str, std::basic_string< char >::size_type __pos=0) -> std::basic_string< char >::size_type
    find_first_of(string self, char const * __s, std::basic_string< char >::size_type __pos, std::basic_string< char >::size_type __n) -> std::basic_string< char >::size_type
    find_first_of(string self, char __c, std::basic_string< char >::size_type __pos=0) -> std::basic_string< char >::size_type

Definition at line 192 of file pcbnew.py.

Here is the caller graph for this function:

◆ find_last_not_of()

def pcbnew.string.find_last_not_of (   self,
args 
)
    find_last_not_of(string self, string __str, std::basic_string< char >::size_type __pos=std::basic_string< char >::npos) -> std::basic_string< char >::size_type
    find_last_not_of(string self, char const * __s, std::basic_string< char >::size_type __pos, std::basic_string< char >::size_type __n) -> std::basic_string< char >::size_type
    find_last_not_of(string self, char __c, std::basic_string< char >::size_type __pos=std::basic_string< char >::npos) -> std::basic_string< char >::size_type

Definition at line 216 of file pcbnew.py.

Here is the caller graph for this function:

◆ find_last_of()

def pcbnew.string.find_last_of (   self,
args 
)
    find_last_of(string self, string __str, std::basic_string< char >::size_type __pos=std::basic_string< char >::npos) -> std::basic_string< char >::size_type
    find_last_of(string self, char const * __s, std::basic_string< char >::size_type __pos, std::basic_string< char >::size_type __n) -> std::basic_string< char >::size_type
    find_last_of(string self, char __c, std::basic_string< char >::size_type __pos=std::basic_string< char >::npos) -> std::basic_string< char >::size_type

Definition at line 200 of file pcbnew.py.

Here is the caller graph for this function:

◆ get_allocator()

def pcbnew.string.get_allocator (   self)
get_allocator(string self) -> std::basic_string< char >::allocator_type

Definition at line 256 of file pcbnew.py.

◆ insert()

def pcbnew.string.insert (   self,
args 
)
    insert(string self, std::basic_string< char >::size_type __pos1, string __str) -> string
    insert(string self, std::basic_string< char >::size_type __pos1, string __str, std::basic_string< char >::size_type __pos2, std::basic_string< char >::size_type __n) -> string
    insert(string self, std::basic_string< char >::size_type __pos, char const * __s, std::basic_string< char >::size_type __n) -> string
    insert(string self, std::basic_string< char >::size_type __pos, std::basic_string< char >::size_type __n, char __c) -> string
    insert(string self, std::basic_string< char >::iterator pos, std::basic_string< char >::value_type x) -> std::basic_string< char >::iterator
    insert(string self, std::basic_string< char >::iterator pos, std::basic_string< char >::size_type n, std::basic_string< char >::value_type x)
    insert(string self, std::basic_string< char >::iterator __p, std::basic_string< char >::size_type __n, char __c)

Definition at line 348 of file pcbnew.py.

Here is the caller graph for this function:

◆ iterator()

def pcbnew.string.iterator (   self)
iterator(string self) -> SwigPyIterator

Definition at line 293 of file pcbnew.py.

Here is the caller graph for this function:

◆ length()

def pcbnew.string.length (   self)
length(string self) -> std::basic_string< char >::size_type

Definition at line 152 of file pcbnew.py.

◆ max_size()

def pcbnew.string.max_size (   self)
max_size(string self) -> std::basic_string< char >::size_type

Definition at line 156 of file pcbnew.py.

◆ rbegin()

def pcbnew.string.rbegin (   self)
rbegin(string self) -> std::basic_string< char >::reverse_iterator

Definition at line 248 of file pcbnew.py.

◆ rend()

def pcbnew.string.rend (   self)
rend(string self) -> std::basic_string< char >::reverse_iterator

Definition at line 252 of file pcbnew.py.

◆ replace()

def pcbnew.string.replace (   self,
args 
)
    replace(string self, std::basic_string< char >::size_type __pos, std::basic_string< char >::size_type __n, string __str) -> string
    replace(string self, std::basic_string< char >::size_type __pos1, std::basic_string< char >::size_type __n1, string __str, std::basic_string< char >::size_type __pos2, std::basic_string< char >::size_type __n2) -> string
    replace(string self, std::basic_string< char >::size_type __pos, std::basic_string< char >::size_type __n1, char const * __s, std::basic_string< char >::size_type __n2) -> string
    replace(string self, std::basic_string< char >::size_type __pos, std::basic_string< char >::size_type __n1, std::basic_string< char >::size_type __n2, char __c) -> string
    replace(string self, std::basic_string< char >::iterator __i1, std::basic_string< char >::iterator __i2, string __str) -> string
    replace(string self, std::basic_string< char >::iterator __i1, std::basic_string< char >::iterator __i2, char const * __s, std::basic_string< char >::size_type __n) -> string
    replace(string self, std::basic_string< char >::iterator __i1, std::basic_string< char >::iterator __i2, std::basic_string< char >::size_type __n, char __c) -> string
    replace(string self, std::basic_string< char >::iterator __i1, std::basic_string< char >::iterator __i2, char const * __k1, char const * __k2) -> string
    replace(string self, std::basic_string< char >::iterator __i1, std::basic_string< char >::iterator __i2, std::basic_string< char >::const_iterator __k1, std::basic_string< char >::const_iterator __k2) -> string

Definition at line 360 of file pcbnew.py.

Here is the caller graph for this function:

◆ reserve()

def pcbnew.string.reserve (   self,
  __res_arg = 0 
)
reserve(string self, std::basic_string< char >::size_type __res_arg=0)

Definition at line 164 of file pcbnew.py.

◆ resize()

def pcbnew.string.resize (   self,
args 
)
    resize(string self, std::basic_string< char >::size_type new_size)
    resize(string self, std::basic_string< char >::size_type new_size, std::basic_string< char >::value_type x)

Definition at line 286 of file pcbnew.py.

Here is the caller graph for this function:

◆ rfind()

def pcbnew.string.rfind (   self,
args 
)
    rfind(string self, string __str, std::basic_string< char >::size_type __pos=std::basic_string< char >::npos) -> std::basic_string< char >::size_type
    rfind(string self, char const * __s, std::basic_string< char >::size_type __pos, std::basic_string< char >::size_type __n) -> std::basic_string< char >::size_type
    rfind(string self, char __c, std::basic_string< char >::size_type __pos=std::basic_string< char >::npos) -> std::basic_string< char >::size_type

Definition at line 184 of file pcbnew.py.

Here is the caller graph for this function:

◆ size()

def pcbnew.string.size (   self)
size(string self) -> std::basic_string< char >::size_type

Definition at line 232 of file pcbnew.py.

◆ substr()

def pcbnew.string.substr (   self,
args 
)
substr(string self, std::basic_string< char >::size_type __pos=0, std::basic_string< char >::size_type __n=std::basic_string< char >::npos) -> string

Definition at line 224 of file pcbnew.py.

◆ swap()

def pcbnew.string.swap (   self,
  v 
)
swap(string self, string v)

Definition at line 236 of file pcbnew.py.

Property Documentation

◆ thisown

pcbnew.string.thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
static

Definition at line 149 of file pcbnew.py.


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