mirror of
https://bitbucket.org/chromiumembedded/cef
synced 2025-06-05 21:39:12 +02:00
Update include/ comments to Doxygen formatting (see issue #3384)
See related guidelines in the issue.
This commit is contained in:
@@ -33,7 +33,7 @@
|
||||
// by hand. See the translator.README.txt file in the tools directory for
|
||||
// more information.
|
||||
//
|
||||
// $hash=1a9b9718367ec8d575fbb39b73b1085b17eb0a2b$
|
||||
// $hash=22959da4d5a2c94edc7647334507e38c44d40250$
|
||||
//
|
||||
|
||||
#ifndef CEF_INCLUDE_CAPI_CEF_PRINT_SETTINGS_CAPI_H_
|
||||
@@ -47,41 +47,41 @@ extern "C" {
|
||||
#endif
|
||||
|
||||
///
|
||||
// Structure representing print settings.
|
||||
/// Structure representing print settings.
|
||||
///
|
||||
typedef struct _cef_print_settings_t {
|
||||
///
|
||||
// Base structure.
|
||||
/// Base structure.
|
||||
///
|
||||
cef_base_ref_counted_t base;
|
||||
|
||||
///
|
||||
// Returns true (1) if this object is valid. Do not call any other functions
|
||||
// if this function returns false (0).
|
||||
/// Returns true (1) if this object is valid. Do not call any other functions
|
||||
/// if this function returns false (0).
|
||||
///
|
||||
int(CEF_CALLBACK* is_valid)(struct _cef_print_settings_t* self);
|
||||
|
||||
///
|
||||
// Returns true (1) if the values of this object are read-only. Some APIs may
|
||||
// expose read-only objects.
|
||||
/// Returns true (1) if the values of this object are read-only. Some APIs may
|
||||
/// expose read-only objects.
|
||||
///
|
||||
int(CEF_CALLBACK* is_read_only)(struct _cef_print_settings_t* self);
|
||||
|
||||
///
|
||||
// Set the page orientation.
|
||||
/// Set the page orientation.
|
||||
///
|
||||
void(CEF_CALLBACK* set_orientation)(struct _cef_print_settings_t* self,
|
||||
int landscape);
|
||||
|
||||
///
|
||||
// Returns true (1) if the orientation is landscape.
|
||||
/// Returns true (1) if the orientation is landscape.
|
||||
///
|
||||
int(CEF_CALLBACK* is_landscape)(struct _cef_print_settings_t* self);
|
||||
|
||||
///
|
||||
// Set the printer printable area in device units. Some platforms already
|
||||
// provide flipped area. Set |landscape_needs_flip| to false (0) on those
|
||||
// platforms to avoid double flipping.
|
||||
/// Set the printer printable area in device units. Some platforms already
|
||||
/// provide flipped area. Set |landscape_needs_flip| to false (0) on those
|
||||
/// platforms to avoid double flipping.
|
||||
///
|
||||
void(CEF_CALLBACK* set_printer_printable_area)(
|
||||
struct _cef_print_settings_t* self,
|
||||
@@ -90,108 +90,108 @@ typedef struct _cef_print_settings_t {
|
||||
int landscape_needs_flip);
|
||||
|
||||
///
|
||||
// Set the device name.
|
||||
/// Set the device name.
|
||||
///
|
||||
void(CEF_CALLBACK* set_device_name)(struct _cef_print_settings_t* self,
|
||||
const cef_string_t* name);
|
||||
|
||||
///
|
||||
// Get the device name.
|
||||
/// Get the device name.
|
||||
///
|
||||
// The resulting string must be freed by calling cef_string_userfree_free().
|
||||
cef_string_userfree_t(CEF_CALLBACK* get_device_name)(
|
||||
struct _cef_print_settings_t* self);
|
||||
|
||||
///
|
||||
// Set the DPI (dots per inch).
|
||||
/// Set the DPI (dots per inch).
|
||||
///
|
||||
void(CEF_CALLBACK* set_dpi)(struct _cef_print_settings_t* self, int dpi);
|
||||
|
||||
///
|
||||
// Get the DPI (dots per inch).
|
||||
/// Get the DPI (dots per inch).
|
||||
///
|
||||
int(CEF_CALLBACK* get_dpi)(struct _cef_print_settings_t* self);
|
||||
|
||||
///
|
||||
// Set the page ranges.
|
||||
/// Set the page ranges.
|
||||
///
|
||||
void(CEF_CALLBACK* set_page_ranges)(struct _cef_print_settings_t* self,
|
||||
size_t rangesCount,
|
||||
cef_range_t const* ranges);
|
||||
|
||||
///
|
||||
// Returns the number of page ranges that currently exist.
|
||||
/// Returns the number of page ranges that currently exist.
|
||||
///
|
||||
size_t(CEF_CALLBACK* get_page_ranges_count)(
|
||||
struct _cef_print_settings_t* self);
|
||||
|
||||
///
|
||||
// Retrieve the page ranges.
|
||||
/// Retrieve the page ranges.
|
||||
///
|
||||
void(CEF_CALLBACK* get_page_ranges)(struct _cef_print_settings_t* self,
|
||||
size_t* rangesCount,
|
||||
cef_range_t* ranges);
|
||||
|
||||
///
|
||||
// Set whether only the selection will be printed.
|
||||
/// Set whether only the selection will be printed.
|
||||
///
|
||||
void(CEF_CALLBACK* set_selection_only)(struct _cef_print_settings_t* self,
|
||||
int selection_only);
|
||||
|
||||
///
|
||||
// Returns true (1) if only the selection will be printed.
|
||||
/// Returns true (1) if only the selection will be printed.
|
||||
///
|
||||
int(CEF_CALLBACK* is_selection_only)(struct _cef_print_settings_t* self);
|
||||
|
||||
///
|
||||
// Set whether pages will be collated.
|
||||
/// Set whether pages will be collated.
|
||||
///
|
||||
void(CEF_CALLBACK* set_collate)(struct _cef_print_settings_t* self,
|
||||
int collate);
|
||||
|
||||
///
|
||||
// Returns true (1) if pages will be collated.
|
||||
/// Returns true (1) if pages will be collated.
|
||||
///
|
||||
int(CEF_CALLBACK* will_collate)(struct _cef_print_settings_t* self);
|
||||
|
||||
///
|
||||
// Set the color model.
|
||||
/// Set the color model.
|
||||
///
|
||||
void(CEF_CALLBACK* set_color_model)(struct _cef_print_settings_t* self,
|
||||
cef_color_model_t model);
|
||||
|
||||
///
|
||||
// Get the color model.
|
||||
/// Get the color model.
|
||||
///
|
||||
cef_color_model_t(CEF_CALLBACK* get_color_model)(
|
||||
struct _cef_print_settings_t* self);
|
||||
|
||||
///
|
||||
// Set the number of copies.
|
||||
/// Set the number of copies.
|
||||
///
|
||||
void(CEF_CALLBACK* set_copies)(struct _cef_print_settings_t* self,
|
||||
int copies);
|
||||
|
||||
///
|
||||
// Get the number of copies.
|
||||
/// Get the number of copies.
|
||||
///
|
||||
int(CEF_CALLBACK* get_copies)(struct _cef_print_settings_t* self);
|
||||
|
||||
///
|
||||
// Set the duplex mode.
|
||||
/// Set the duplex mode.
|
||||
///
|
||||
void(CEF_CALLBACK* set_duplex_mode)(struct _cef_print_settings_t* self,
|
||||
cef_duplex_mode_t mode);
|
||||
|
||||
///
|
||||
// Get the duplex mode.
|
||||
/// Get the duplex mode.
|
||||
///
|
||||
cef_duplex_mode_t(CEF_CALLBACK* get_duplex_mode)(
|
||||
struct _cef_print_settings_t* self);
|
||||
} cef_print_settings_t;
|
||||
|
||||
///
|
||||
// Create a new cef_print_settings_t object.
|
||||
/// Create a new cef_print_settings_t object.
|
||||
///
|
||||
CEF_EXPORT cef_print_settings_t* cef_print_settings_create(void);
|
||||
|
||||
|
Reference in New Issue
Block a user