Package pyplusplus :: Package decl_wrappers :: Module calldef_wrapper :: Class free_function_t

# type free_function_t

source code

                                         object --+
                                                  |
    pygccxml.declarations.declaration.declaration_t --+
                                                      |
                pygccxml.declarations.calldef.calldef_t --+
                                                          |
               pygccxml.declarations.calldef.free_calldef_t --+
                                                              |
                  pygccxml.declarations.calldef.free_function_t --+
                                                                  |
                                                 object --+       |
                                                          |       |
                                decl_wrapper.decl_wrapper_t --+   |
                                                              |   |
                                                      calldef_t --+
                                                                  |
                                                                 free_function_t

defines a set of properties, that will instruct Py++ how to expose the free function

Instance Methods

__init__(self, *arguments, **keywords) | source code

add_declaration_code(self, code) adds the code to the declaration section | source code

get_use_overload_macro(self) | source code

set_use_overload_macro(self, use_macro) | source code

Inherited from `pygccxml.declarations.calldef.free_calldef_t`: `__str__`, `create_decl_string`, `function_type`

Inherited from `pygccxml.declarations.calldef.calldef_t`: `__eq__`, `i_depend_on_them`

Inherited from `pygccxml.declarations.declaration.declaration_t`: `__lt__`, `__ne__`

Inherited from `calldef_t`: `add_transformation`, `get_call_policies`, `get_overridable`, `has_wrapper`, `mark_as_non_overridable`, `set_call_policies`, `set_overridable`

Inherited from `decl_wrapper.decl_wrapper_t`: `disable_messages`, `disable_warnings`, `exclude`, `get_already_exposed`, `get_exportable`, `include`, `readme`, `rename`, `set_already_exposed`, `set_exportable`, `why_not_exportable`

Class Variables
Inherited from `calldef_t`: `BOOST_PYTHON_MAX_ARITY` Inherited from `decl_wrapper.decl_wrapper_t`: `SPECIAL_TYPEDEF_PICK_ANY`

Properties
| declaration_code List of strings, that contains valid C++ code, that will be added to the same file in which the registration code for the function will be generated
| use_overload_macro boolean, if True, will use BOOST_PYTHON_FUNCTION_OVERLOADS macro to expose declarationsDefault value is False.

Inherited from `pygccxml.declarations.calldef.calldef_t`: `argument_types`, `arguments`, `demangled_name`, `does_throw`, `exceptions`, `has_ellipsis`, `has_extern`, `optional_args`, `overloads`, `required_args`, `return_type`

Inherited from `pygccxml.declarations.declaration.declaration_t`: `attributes`, `cache`, `compiler`, `decl_string`, `demangled`, `is_artificial`, `location`, `mangled`, `name`, `parent`, `partial_decl_string`, `partial_name`, `top_parent`

Inherited from `calldef_t`: `call_policies`, `create_with_signature`, `non_overridable_reason`, `overridable`, `transformations`, `use_default_arguments`, `use_keywords`

Inherited from `decl_wrapper.decl_wrapper_t`: `alias`, `already_exposed`, `disabled_messages`, `documentation`, `exportable`, `ignore`, `include_files`, `logger`

Method Details

### __init__(self, *arguments, **keywords)
(Constructor)

source code

Overrides: decl_wrapper.decl_wrapper_t.__init__

Property Details

### declaration_code

List of strings, that contains valid C++ code, that will be added to the same file in which the registration code for the function will be generated

### use_overload_macro

boolean, if True, will use BOOST_PYTHON_FUNCTION_OVERLOADS macro to expose declarationsDefault value is False.

Get Method:
  get_use_overload_macro(self)
Set Method:
  set_use_overload_macro(self, use_macro)