Section 3: library functions
guestfs-lua – How to use libguestfs from Lua Synopsis local G = require "guestfs" g = G.create () g:add_drive ("test.img", { format = "raw", readonly = true }) g:launch () devices = g:list_devices () g:close ()DescriptionThis manual page documents how to call libguestfs from the Lua programming language. This page just documents the differences from…
QuantLib::FittedBondDiscountCurve::FittingMethod – Base fitting method used to construct a fitted bond discount curve. Synopsis#include <ql/termstructures/yield/fittedbonddiscountcurve.hpp> Inherited by CubicBSplinesFitting, ExponentialSplinesFitting, NelsonSiegelFitting, and SimplePolynomialFitting. Public Member Functionsvirtual Size size () const =0 total number of coefficients to fit/solve for Array solution () const output array of results of optimization problem Integer numberOfIterations () const final number of…
QuantLib::HazardRate – Hazard-rate-curve traits. Synopsis#include <ql/termstructures/credit/probabilitytraits.hpp> Public Typestypedef BootstrapHelper< DefaultProbabilityTermStructure > helper Static Public Member Functionsstatic Date initialDate (const DefaultProbabilityTermStructure *c) static Real initialValue (const DefaultProbabilityTermStructure *) static bool dummyInitialValue () static Real initialGuess () static Real guess (const DefaultProbabilityTermStructure *c, const Date &d) static Real minValueAfter (Size, const std::vector< Real > &) static Real…
set_tab Synopsis#include <gstream.h> void set_tab(int x, int color, FONT fnt); DescriptionThis is the basic function – it creates a tab stop at the specified x-coordinate with the specified colour and the specified font. But the function is overloaded so it is possible only to set a tab stop without changing the font or the font…
set_max_input_length Synopsis#include <gstream.h> void set_max_input_length(int) DescriptionThis sets the maximum number of characters that the inputter will accept from the user at the next, and only the next, input, i.e. if you call this function with 5 set_max_input_length(5);and the user has made the following input abcde|he won’t be able to enter anymore characters before at least…
set_line_spacing Synopsis#include <gstream.h> void set_line_spacing(int ls); DescriptionSets the line spacing in pixels. The supplied value is added to the height of the font so if your font is 12 pixels high, and you call this function with 4, then the outputter will go 16 pixels down each time a newline is encountered, effectively making the…
set_input_string Synopsis#include <gstream.h> void set_input_string(char const *s); DescriptionThis function provides a way to specify an editable default string when inputting. Consider the following example: char buf[100]; gs << "What’s your opinion about gstream?\n"; gs.set_input_string("I think it is incredible wonderful!"); gs.getline(buf, 100);The user will see the following What’s your opinion about gstream? I think it is…
set_input_error_handler Synopsis#include <gstream.h> void set_input_error_handler(int error); DescriptionSets an error handler that will be called of the inputter encounter any unusual, erratic behaviour, e.g. the user trying to move the cursor off the string or pressing invalid keys. The handler is passed a constant which currently can be one of the following: IE_UNRECOGNIZED_KEY The inputted key…
set_input_approver Synopsis#include <gstream.h> void set_input_approver(bool (*input_approver)(int)); DescriptionThe function handed over will be called with every new character inputted and determines whether the character will be accepted by the inputter. If it returns true, the character is accepted and inserted in the input string, if false, the character is thrown away. A short example: bool ia_abc_is_what_we_want(int…
set_dirty_rectangle_marker Synopsis#include <gstream.h> void set_dirty_rectangle_marker(void (*drm)(int, int, int, int)) DescriptionSets a function which the gstream will use to mark the areas that it draws inside as "dirty"; this can, for instance, be very useful in conjuction with a dirty rectangle system in a game where you are using the gstream to output various information during…
set_cursor_drawer Synopsis#include <gstream.h> void set_cursor_drawer(void (*cd)(BITMAP *, int, int, int, int, int, bool)); DescriptionThis will set the function for drawing the cursor, which is useful if you want to customize it with your own favourite cursor (perhaps a BITMAP). Before you can actually use the cursor for inputting, you also have to call set_cursor_dimensions with…
set_cursor_dimensions Synopsis#include <gstream.h> void set_cursor_dimensions(int iw, int ih, int ow, int oh); DescriptionThis will set the cursor dimensions to IW x IH when in insert mode and OW x OH when in overwrite mode. Although the standard cursors respond to this, it is mostly intended to be used with custom cursor drawers. Before requesting any…
save_input_approver Synopsis#include <gstream.h> void save_input_approver(); DescriptionA typical use of the input approver system is to temporarily set a home-made approver, launch an input and then get the original settings back. Consequently there is a pair of functions to help you with that, save_input_approver and restore_input_approver. Saving will backup the currently used approver, so you can…
restore_input_approver Synopsis#include <gstream.h> void restore_input_approver(); DescriptionRestores the previously saved backup. You can call this function as many times as you want, i.e. the backup will remain the same until you save another approver. See Alsogstream-save_input_approver(3), gstream-set_input_approver(3), gstream-get_input_approver(3)
restore Synopsis#include <gstream.h> void restore(); DescriptionWhen you have activated a tabulator stop (by using the ‘\t’ character), it might change the colour or the font depending on what or what not you have told it to do. To get the original settings back you can call this function. It is automatically called when a newline…
operator, operator Synopsis#include <gstream.h> ostream& operator<<(ostream& o, fix const& x); istream& operator>>(istream& i, fix& x); DescriptionThese two functions don’t actually belong to the gstreams, they are here simply because they sometimes make the life a bit easier (without costing anything in executable size if they are left unused). Their purpose is to make the class…
goto_row Synopsis#include <gstream.h> void goto_row(int row); DescriptionMoves the cursor to line number ROW. If, for instance, the currently used font has a height of 12, then goto_row(4) is exactly the same as goto_y(4*12). Unless, of course, you use another line spacing than the default as the formula is y-coordinate = line_spacing * rowSee Alsogstream-move_row(3), gstream-goto_xy(3)
cd_winconsole Synopsis#include <gstream.h> void cd_winconsole(BITMAP *bmp, int x, int y, int w, int h, int clr, bool ins); DescriptionDraws a mixture of a win cursor and console cursor: the insert cursor looks like a win cursor (a vertical line: | ), whereas the overwrite cursor is like the console overwrite cursor (it covers the letter)….
cd_console Synopsis#include <gstream.h> void cd_console(BITMAP *bmp, int x, int y, int w, int h, int clr, bool ins); DescriptionDraws a normal console cursor: the insert cursor is like an _, and the overwrite cursor covers the letter. The preferred dimensions (you have to set them manually) are: (gbuf::DYNAMIC_CURSOR_SIZE, gbuf::DYNAMIC_CURSOR_SIZE, gbuf::DYNAMIC_CURSOR_SIZE, gbuf::DYNAMIC_CURSOR_SIZE) but the second argument…
GSTREAM_DATE_STR Synopsis#include <gstream.h> char GSTREAM_DATE_STR[] DescriptionThis will contain the year of the current version of the library. For example, for version 1.0 of the library, this string will be "1999". (For version 19.43 it will probably be "3061" :-) See Alsogstream-GSTREAM_VERSION_STR(3), gstream-GSTREAM_VERSION(3), gstream-GSTREAM_SUB_VERSION(3)