libDXF 0.0.1
A library with DXF related functions written in C.
Functions

oleframe.c File Reference

Functions for a DXF oleframe entity (OLEFRAME). More...

#include "oleframe.h"
Include dependency graph for oleframe.c:

Go to the source code of this file.

Functions

DxfOleFrame * dxf_oleframe_new ()
 Allocate memory for a DxfOleFrame.
DxfOleFrame * dxf_oleframe_init (DxfOleFrame *oleframe)
 Allocate memory and initialize data fields in a OLEFRAME entity.
DxfOleFrame * dxf_oleframe_read (DxfFile *fp, DxfOleFrame *oleframe)
 Read data from a DXF file into a DXF OLEFRAME entity.
int dxf_oleframe_write (DxfFile *fp, DxfOleFrame *oleframe)
 Write DXF output to a file for a DXF OLEFRAME entity.
int dxf_oleframe_free (DxfOleFrame *oleframe)
 Free the allocated memory for a DXF OLEFRAME and all it's data fields.
void dxf_oleframe_free_chain (DxfOleFrame *oleframes)
 Free the allocated memory for a chain of DXF OLEFRAME entities and all their data fields.
int dxf_oleframe_get_id_code (DxfOleFrame *oleframe)
 Get the id_code from a DXF OLEFRAME entity.
DxfOleFrame * dxf_oleframe_set_id_code (DxfOleFrame *oleframe, int id_code)
 Set the id_code for a DXF OLEFRAME entity.
char * dxf_oleframe_get_linetype (DxfOleFrame *oleframe)
 Get the linetype from a DXF OLEFRAME entity.
DxfOleFrame * dxf_oleframe_set_linetype (DxfOleFrame *oleframe, char *linetype)
 Set the linetype for a DXF OLEFRAME entity.
char * dxf_oleframe_get_layer (DxfOleFrame *oleframe)
 Get the layer from a DXF OLEFRAME entity.
DxfOleFrame * dxf_oleframe_set_layer (DxfOleFrame *oleframe, char *layer)
 Set the layer for a DXF OLEFRAME entity.
double dxf_oleframe_get_elevation (DxfOleFrame *oleframe)
 Get the elevation from a DXF OLEFRAME entity.
DxfOleFrame * dxf_oleframe_set_elevation (DxfOleFrame *oleframe, double elevation)
 Set the elevation for a DXF OLEFRAME entity.
double dxf_oleframe_get_thickness (DxfOleFrame *oleframe)
 Get the thickness from a DXF OLEFRAME entity.
DxfOleFrame * dxf_oleframe_set_thickness (DxfOleFrame *oleframe, double thickness)
 Set the thickness for a DXF OLEFRAME entity.
double dxf_oleframe_get_linetype_scale (DxfOleFrame *oleframe)
 Get the linetype_scale from a DXF OLEFRAME entity.
DxfOleFrame * dxf_oleframe_set_linetype_scale (DxfOleFrame *oleframe, double linetype_scale)
 Set the linetype_scale for a DXF OLEFRAME entity.
int16_t dxf_oleframe_get_visibility (DxfOleFrame *oleframe)
 Get the visibility from a DXF OLEFRAME entity.
DxfOleFrame * dxf_oleframe_set_visibility (DxfOleFrame *oleframe, int16_t visibility)
 Set the visibility for a DXF OLEFRAME entity.
int dxf_oleframe_get_color (DxfOleFrame *oleframe)
 Get the color from a DXF OLEFRAME entity.
DxfOleFrame * dxf_oleframe_set_color (DxfOleFrame *oleframe, int color)
 Set the color for a DXF OLEFRAME entity.
int dxf_oleframe_get_paperspace (DxfOleFrame *oleframe)
 Get the paperspace flag value from a DXF OLEFRAME entity.
DxfOleFrame * dxf_oleframe_set_paperspace (DxfOleFrame *oleframe, int paperspace)
 Set the paperspace flag for a DXF OLEFRAME entity.
int dxf_oleframe_get_graphics_data_size (DxfOleFrame *oleframe)
 Get the graphics_data_size value from a DXF OLEFRAME entity.
DxfOleFrame * dxf_oleframe_set_graphics_data_size (DxfOleFrame *oleframe, int graphics_data_size)
 Set the graphics_data_size value for a DXF OLEFRAME entity.
int16_t dxf_oleframe_get_shadow_mode (DxfOleFrame *oleframe)
 Get the shadow_mode from a DXF OLEFRAME entity.
DxfOleFrame * dxf_oleframe_set_shadow_mode (DxfOleFrame *oleframe, int16_t shadow_mode)
 Set the shadow_mode for a DXF OLEFRAME entity.
DxfBinaryGraphicsData * dxf_oleframe_get_binary_graphics_data (DxfOleFrame *oleframe)
 Get the pointer to the binary_graphics_data from a DXF OLEFRAME entity.
DxfOleFrame * dxf_oleframe_set_binary_graphics_data (DxfOleFrame *oleframe, DxfBinaryGraphicsData *data)
 Set the pointer to the binary_graphics_data for a DXF OLEFRAME entity.
char * dxf_oleframe_get_dictionary_owner_soft (DxfOleFrame *oleframe)
 Get the soft pointer to the dictionary owner from a DXF OLEFRAME entity.
DxfOleFrame * dxf_oleframe_set_dictionary_owner_soft (DxfOleFrame *oleframe, char *dictionary_owner_soft)
 Set the pointer to the dictionary_owner_soft for a DXF OLEFRAME entity.
char * dxf_oleframe_get_material (DxfOleFrame *oleframe)
 Get the pointer to the material from a DXF OLEFRAME entity.
DxfOleFrame * dxf_oleframe_set_material (DxfOleFrame *oleframe, char *material)
 Set the pointer to the material for a DXF OLEFRAME entity.
char * dxf_oleframe_get_dictionary_owner_hard (DxfOleFrame *oleframe)
 Get the hard pointer to the dictionary owner from a DXF OLEFRAME entity.
DxfOleFrame * dxf_oleframe_set_dictionary_owner_hard (DxfOleFrame *oleframe, char *dictionary_owner_hard)
 Set the pointer to the dictionary_owner_hard for a DXF OLEFRAME entity.
int16_t dxf_oleframe_get_lineweight (DxfOleFrame *oleframe)
 Get the lineweight from a DXF OLEFRAME entity.
DxfOleFrame * dxf_oleframe_set_lineweight (DxfOleFrame *oleframe, int16_t lineweight)
 Set the lineweight for a DXF OLEFRAME entity.
char * dxf_oleframe_get_plot_style_name (DxfOleFrame *oleframe)
 Get the plot_style_name from a DXF OLEFRAME entity.
DxfOleFrame * dxf_oleframe_set_plot_style_name (DxfOleFrame *oleframe, char *plot_style_name)
 Set the plot_style_name for a DXF OLEFRAME entity.
long dxf_oleframe_get_color_value (DxfOleFrame *oleframe)
 Get the color_value from a DXF OLEFRAME entity.
DxfOleFrame * dxf_oleframe_set_color_value (DxfOleFrame *oleframe, long color_value)
 Set the color_value for a DXF OLEFRAME entity.
char * dxf_oleframe_get_color_name (DxfOleFrame *oleframe)
 Get the color_name from a DXF OLEFRAME entity.
DxfOleFrame * dxf_oleframe_set_color_name (DxfOleFrame *oleframe, char *color_name)
 Set the color_name for a DXF OLEFRAME entity.
long dxf_oleframe_get_transparency (DxfOleFrame *oleframe)
 Get the transparency from a DXF OLEFRAME entity.
DxfOleFrame * dxf_oleframe_set_transparency (DxfOleFrame *oleframe, long transparency)
 Set the transparency for a DXF OLEFRAME entity.
int dxf_oleframe_get_ole_version_number (DxfOleFrame *oleframe)
 Get the ole_version_number from a DXF OLEFRAME entity.
DxfOleFrame * dxf_oleframe_set_ole_version_number (DxfOleFrame *oleframe, int ole_version_number)
 Set the ole_version_number for a DXF OLEFRAME entity.
long dxf_oleframe_get_length (DxfOleFrame *oleframe)
 Get the length from a DXF OLEFRAME entity.
DxfOleFrame * dxf_oleframe_set_length (DxfOleFrame *oleframe, long length)
 Set the length for a DXF OLEFRAME entity.
DxfChar * dxf_oleframe_get_binary_data (DxfOleFrame *oleframe)
 Get the binary_data from a DXF OLEFRAME entity.
DxfOleFrame * dxf_oleframe_set_binary_data (DxfOleFrame *oleframe, DxfChar *binary_data)
 Set the binary_data for a DXF OLEFRAME entity.
DxfOleFrame * dxf_oleframe_get_next (DxfOleFrame *oleframe)
 Get the pointer to the next OLEFRAME entity from a DXF OLEFRAME entity.
DxfOleFrame * dxf_oleframe_set_next (DxfOleFrame *oleframe, DxfOleFrame *next)
 Set the pointer to the next OLEFRAME for a DXF OLEFRAME entity.
DxfOleFrame * dxf_oleframe_get_last (DxfOleFrame *oleframe)
 Get the pointer to the last OLEFRAME entity from a linked list of DXF OLEFRAME entities.

Detailed Description

Functions for a DXF oleframe entity (OLEFRAME).

Author:
Copyright (C) 2013, 2014, 2015, 2017 by Bert Timmerman <bert.timmerman@xs4all.nl>.

Copyright Notices.


This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to:
Free Software Foundation, Inc.,
59 Temple Place,
Suite 330,
Boston,
MA 02111 USA.

Drawing eXchange Format (DXF) is a defacto industry standard for the exchange of drawing files between various Computer Aided Drafting programs.
DXF is an industry standard designed by Autodesk(TM).
For more details see http://www.autodesk.com.

Definition in file oleframe.c.

Function Documentation

DxfOleFrame* dxf_oleframe_new ( )

Allocate memory for a DxfOleFrame.

Fill the memory contents with zeros.

Version:
According to DXF R13.
According to DXF R14.

Definition at line 48 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

Referenced by dxf_oleframe_init(), and dxf_oleframe_read().

DxfOleFrame* dxf_oleframe_init ( DxfOleFrame *  oleframe)

Allocate memory and initialize data fields in a OLEFRAME entity.

Returns:
NULL when no memory was allocated, a pointer to the allocated memory when succesful.
Version:
According to DXF R13.
According to DXF R14.
Parameters:
oleframea pointer to the DXF OLEFRAME entity.

Definition at line 89 of file oleframe.c.

References _, dxf_oleframe_struct::binary_data, dxf_oleframe_struct::color, dxf_oleframe_struct::dictionary_owner_hard, dxf_oleframe_struct::dictionary_owner_soft, dxf_char_init(), dxf_char_new(), DXF_COLOR_BYLAYER, DXF_DEBUG_BEGIN, DXF_DEBUG_END, DXF_DEFAULT_LAYER, DXF_DEFAULT_LINETYPE, DXF_DEFAULT_LINETYPE_SCALE, DXF_DEFAULT_VISIBILITY, DXF_MODELSPACE, dxf_oleframe_new(), dxf_oleframe_struct::elevation, dxf_oleframe_struct::id_code, dxf_oleframe_struct::layer, dxf_char_struct::length, dxf_oleframe_struct::length, dxf_oleframe_struct::linetype, dxf_oleframe_struct::linetype_scale, dxf_oleframe_struct::next, dxf_char_struct::next, dxf_oleframe_struct::ole_version_number, dxf_oleframe_struct::paperspace, dxf_oleframe_struct::thickness, dxf_char_struct::value, and dxf_oleframe_struct::visibility.

Referenced by dxf_oleframe_read().

Here is the call graph for this function:

DxfOleFrame* dxf_oleframe_read ( DxfFile *  fp,
DxfOleFrame *  oleframe 
)

Read data from a DXF file into a DXF OLEFRAME entity.

The last line read from file contained the string "OLEFRAME".
Now follows some data for the OLEFRAME, to be terminated with a " 0" string announcing the following entity, or the end of the ENTITY section marker ENDSEC.
While parsing the DXF file store data in oleframe.

Returns:
a pointer to oleframe.
Version:
According to DXF R13.
According to DXF R14.
Parameters:
fpDXF file pointer to an input file (or device).
oleframea pointer to the DXF OLEFRAME entity.

Definition at line 154 of file oleframe.c.

References _, dxf_file_struct::acad_version_number, AutoCAD_11, AutoCAD_13, dxf_oleframe_struct::binary_data, dxf_oleframe_struct::color, dxf_oleframe_struct::dictionary_owner_hard, dxf_oleframe_struct::dictionary_owner_soft, dxf_char_init(), DXF_DEBUG_BEGIN, DXF_DEBUG_END, DXF_DEFAULT_LAYER, DXF_DEFAULT_LINETYPE, dxf_oleframe_init(), dxf_oleframe_new(), dxf_oleframe_struct::elevation, dxf_file_struct::filename, dxf_file_struct::fp, dxf_oleframe_struct::id_code, dxf_oleframe_struct::layer, dxf_oleframe_struct::length, dxf_file_struct::line_number, dxf_oleframe_struct::linetype, dxf_oleframe_struct::linetype_scale, dxf_char_struct::next, dxf_oleframe_struct::ole_version_number, dxf_oleframe_struct::paperspace, dxf_oleframe_struct::thickness, dxf_char_struct::value, and dxf_oleframe_struct::visibility.

Here is the call graph for this function:

int dxf_oleframe_write ( DxfFile *  fp,
DxfOleFrame *  oleframe 
)

Write DXF output to a file for a DXF OLEFRAME entity.

Returns:
EXIT_SUCCESS when done, or EXIT_FAILURE when an error occurred while reading from the input file.
Version:
According to DXF R13.
According to DXF R14.

Todo:
for version R14.
Implementing the start of application-defined group "{application_name", with Group code 102.
For example: "{ACAD_REACTORS" indicates the start of the AutoCAD persistent reactors group.

application-defined codes: Group codes and values within the 102 groups are application defined (optional).

End of group, "}" (optional), with Group code 102.

Parameters:
fpDXF file pointer to an output file (or device).
oleframea pointer to the DXF OLEFRAME entity.

Definition at line 371 of file oleframe.c.

References _, dxf_file_struct::acad_version_number, AutoCAD_11, AutoCAD_13, AutoCAD_14, dxf_oleframe_struct::binary_data, dxf_oleframe_struct::color, dxf_oleframe_struct::dictionary_owner_hard, dxf_oleframe_struct::dictionary_owner_soft, DXF_COLOR_BYLAYER, DXF_DEBUG_BEGIN, DXF_DEBUG_END, DXF_DEFAULT_LAYER, DXF_DEFAULT_LINETYPE, DXF_FLATLAND, DXF_PAPERSPACE, dxf_oleframe_struct::elevation, dxf_file_struct::fp, dxf_oleframe_struct::id_code, dxf_oleframe_struct::layer, dxf_oleframe_struct::length, dxf_oleframe_struct::linetype, dxf_oleframe_struct::linetype_scale, dxf_char_struct::next, dxf_oleframe_struct::ole_version_number, dxf_oleframe_struct::paperspace, dxf_oleframe_struct::thickness, dxf_char_struct::value, and dxf_oleframe_struct::visibility.

int dxf_oleframe_free ( DxfOleFrame *  oleframe)

Free the allocated memory for a DXF OLEFRAME and all it's data fields.

Returns:
EXIT_SUCCESS when done, or EXIT_FAILURE when an error occurred.
Version:
According to DXF R13.
According to DXF R14.
Parameters:
oleframea pointer to the memory occupied by the DXF OLEFRAME entity.

Definition at line 535 of file oleframe.c.

References _, dxf_oleframe_struct::binary_data, dxf_oleframe_struct::dictionary_owner_hard, dxf_oleframe_struct::dictionary_owner_soft, dxf_char_free_chain(), DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_oleframe_struct::layer, dxf_oleframe_struct::linetype, and dxf_oleframe_struct::next.

Referenced by dxf_oleframe_free_chain().

Here is the call graph for this function:

void dxf_oleframe_free_chain ( DxfOleFrame *  oleframes)

Free the allocated memory for a chain of DXF OLEFRAME entities and all their data fields.

Version:
According to DXF R10 (backward compatibility).
According to DXF R11 (backward compatibility).
According to DXF R12 (backward compatibility).
According to DXF R13.
According to DXF R14.
Parameters:
oleframesa pointer to the chain of DXF OLEFRAME entities.

Definition at line 585 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, dxf_oleframe_free(), and dxf_oleframe_struct::next.

Here is the call graph for this function:

int dxf_oleframe_get_id_code ( DxfOleFrame *  oleframe)

Get the id_code from a DXF OLEFRAME entity.

Returns:
id_code.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.

Definition at line 618 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::id_code.

DxfOleFrame* dxf_oleframe_set_id_code ( DxfOleFrame *  oleframe,
int  id_code 
)

Set the id_code for a DXF OLEFRAME entity.

Parameters:
oleframea pointer to a DXF OLEFRAME entity.
id_codeIdentification number for the entity.
This is to be an unique (sequential) number in the DXF file.

Definition at line 652 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::id_code.

char* dxf_oleframe_get_linetype ( DxfOleFrame *  oleframe)

Get the linetype from a DXF OLEFRAME entity.

Returns:
linetype when sucessful, NULL when an error occurred.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.

Definition at line 693 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::linetype.

DxfOleFrame* dxf_oleframe_set_linetype ( DxfOleFrame *  oleframe,
char *  linetype 
)

Set the linetype for a DXF OLEFRAME entity.

Parameters:
oleframea pointer to a DXF OLEFRAME entity.
linetypea string containing the linetype for the entity.

Definition at line 728 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::linetype.

char* dxf_oleframe_get_layer ( DxfOleFrame *  oleframe)

Get the layer from a DXF OLEFRAME entity.

Returns:
layer when sucessful, NULL when an error occurred.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.

Definition at line 768 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::layer.

DxfOleFrame* dxf_oleframe_set_layer ( DxfOleFrame *  oleframe,
char *  layer 
)

Set the layer for a DXF OLEFRAME entity.

Parameters:
oleframea pointer to a DXF OLEFRAME entity.
layera string containing the layer for the entity.

Definition at line 803 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::layer.

double dxf_oleframe_get_elevation ( DxfOleFrame *  oleframe)

Get the elevation from a DXF OLEFRAME entity.

Returns:
elevation.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.

Definition at line 843 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::elevation.

DxfOleFrame* dxf_oleframe_set_elevation ( DxfOleFrame *  oleframe,
double  elevation 
)

Set the elevation for a DXF OLEFRAME entity.

Parameters:
oleframea pointer to a DXF OLEFRAME entity.
elevationthe elevation to be set for the entity.

Definition at line 871 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::elevation.

double dxf_oleframe_get_thickness ( DxfOleFrame *  oleframe)

Get the thickness from a DXF OLEFRAME entity.

Returns:
thickness.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.

Definition at line 904 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::thickness.

DxfOleFrame* dxf_oleframe_set_thickness ( DxfOleFrame *  oleframe,
double  thickness 
)

Set the thickness for a DXF OLEFRAME entity.

Parameters:
oleframea pointer to a DXF OLEFRAME entity.
thicknessthe thickness to be set for the entity.

Definition at line 938 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::thickness.

double dxf_oleframe_get_linetype_scale ( DxfOleFrame *  oleframe)

Get the linetype_scale from a DXF OLEFRAME entity.

Returns:
linetype_scale.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.

Definition at line 977 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::linetype_scale.

DxfOleFrame* dxf_oleframe_set_linetype_scale ( DxfOleFrame *  oleframe,
double  linetype_scale 
)

Set the linetype_scale for a DXF OLEFRAME entity.

Parameters:
oleframea pointer to a DXF OLEFRAME entity.
linetype_scalethe linetype_scale to be set for the entity.

Definition at line 1011 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::linetype_scale.

int16_t dxf_oleframe_get_visibility ( DxfOleFrame *  oleframe)

Get the visibility from a DXF OLEFRAME entity.

Returns:
visibility.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.

Definition at line 1050 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::visibility.

DxfOleFrame* dxf_oleframe_set_visibility ( DxfOleFrame *  oleframe,
int16_t  visibility 
)

Set the visibility for a DXF OLEFRAME entity.

Parameters:
oleframea pointer to a DXF OLEFRAME entity.
visibilitythe visibility to be set for the entity.

Definition at line 1090 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::visibility.

int dxf_oleframe_get_color ( DxfOleFrame *  oleframe)

Get the color from a DXF OLEFRAME entity.

Returns:
color.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.

Definition at line 1135 of file oleframe.c.

References _, dxf_oleframe_struct::color, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

DxfOleFrame* dxf_oleframe_set_color ( DxfOleFrame *  oleframe,
int  color 
)

Set the color for a DXF OLEFRAME entity.

Parameters:
oleframea pointer to a DXF OLEFRAME entity.
colorthe color to be set for the entity.

Definition at line 1169 of file oleframe.c.

References _, dxf_oleframe_struct::color, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

int dxf_oleframe_get_paperspace ( DxfOleFrame *  oleframe)

Get the paperspace flag value from a DXF OLEFRAME entity.

Returns:
paperspace flag value.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.

Definition at line 1208 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::paperspace.

DxfOleFrame* dxf_oleframe_set_paperspace ( DxfOleFrame *  oleframe,
int  paperspace 
)

Set the paperspace flag for a DXF OLEFRAME entity.

Parameters:
oleframea pointer to a DXF OLEFRAME entity.
paperspacethe paperspace flag value to be set for the entity.

Definition at line 1248 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::paperspace.

int dxf_oleframe_get_graphics_data_size ( DxfOleFrame *  oleframe)

Get the graphics_data_size value from a DXF OLEFRAME entity.

Returns:
graphics_data_size value when successful, or EXIT_FAILURE when an error occurred.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.

Definition at line 1296 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::graphics_data_size.

DxfOleFrame* dxf_oleframe_set_graphics_data_size ( DxfOleFrame *  oleframe,
int  graphics_data_size 
)

Set the graphics_data_size value for a DXF OLEFRAME entity.

Returns:
a pointer to oleframe when successful, or NULL when an error occurred.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.
graphics_data_sizethe graphics_data_size value to be set for the entity.

Definition at line 1339 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::graphics_data_size.

int16_t dxf_oleframe_get_shadow_mode ( DxfOleFrame *  oleframe)

Get the shadow_mode from a DXF OLEFRAME entity.

Returns:
shadow_mode when successful, or EXIT_FAILURE when an error occurred.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.

Definition at line 1387 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::shadow_mode.

DxfOleFrame* dxf_oleframe_set_shadow_mode ( DxfOleFrame *  oleframe,
int16_t  shadow_mode 
)

Set the shadow_mode for a DXF OLEFRAME entity.

Returns:
a pointer to oleframe when successful, or NULL when an error occurred.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.
shadow_modethe shadow mode to be set for the entity.

Definition at line 1430 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::shadow_mode.

DxfBinaryGraphicsData* dxf_oleframe_get_binary_graphics_data ( DxfOleFrame *  oleframe)

Get the pointer to the binary_graphics_data from a DXF OLEFRAME entity.

Returns:
pointer to the binary_graphics_data.
Warning:
No checks are performed on the returned pointer.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.

Definition at line 1478 of file oleframe.c.

References _, dxf_oleframe_struct::binary_graphics_data, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

DxfOleFrame* dxf_oleframe_set_binary_graphics_data ( DxfOleFrame *  oleframe,
DxfBinaryGraphicsData *  data 
)

Set the pointer to the binary_graphics_data for a DXF OLEFRAME entity.

Parameters:
oleframea pointer to a DXF OLEFRAME entity.
dataa string containing the pointer to the binary_graphics_data for the entity.

Definition at line 1514 of file oleframe.c.

References _, dxf_oleframe_struct::binary_graphics_data, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

char* dxf_oleframe_get_dictionary_owner_soft ( DxfOleFrame *  oleframe)

Get the soft pointer to the dictionary owner from a DXF OLEFRAME entity.

Returns:
soft pointer to the dictionary owner.
Warning:
No checks are performed on the returned pointer (string).
Parameters:
oleframea pointer to a DXF OLEFRAME entity.

Definition at line 1558 of file oleframe.c.

References _, dxf_oleframe_struct::dictionary_owner_soft, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

DxfOleFrame* dxf_oleframe_set_dictionary_owner_soft ( DxfOleFrame *  oleframe,
char *  dictionary_owner_soft 
)

Set the pointer to the dictionary_owner_soft for a DXF OLEFRAME entity.

Parameters:
oleframea pointer to a DXF OLEFRAME entity.
dictionary_owner_softa string containing the pointer to the dictionary_owner_soft for the entity.

Definition at line 1594 of file oleframe.c.

References _, dxf_oleframe_struct::dictionary_owner_soft, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

char* dxf_oleframe_get_material ( DxfOleFrame *  oleframe)

Get the pointer to the material from a DXF OLEFRAME entity.

Returns:
a pointer to material when successful, or NULL when an error occurred.
Warning:
No checks are performed on the returned pointer.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.

Definition at line 1638 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::material.

DxfOleFrame* dxf_oleframe_set_material ( DxfOleFrame *  oleframe,
char *  material 
)

Set the pointer to the material for a DXF OLEFRAME entity.

Returns:
a pointer to oleframe when successful, or NULL when an error occurred.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.
materiala string containing the pointer to the material for the entity.

Definition at line 1677 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::material.

char* dxf_oleframe_get_dictionary_owner_hard ( DxfOleFrame *  oleframe)

Get the hard pointer to the dictionary owner from a DXF OLEFRAME entity.

Returns:
hard pointer to the dictionary owner.
Warning:
No checks are performed on the returned pointer (string).
Parameters:
oleframea pointer to a DXF OLEFRAME entity.

Definition at line 1721 of file oleframe.c.

References _, dxf_oleframe_struct::dictionary_owner_hard, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

DxfOleFrame* dxf_oleframe_set_dictionary_owner_hard ( DxfOleFrame *  oleframe,
char *  dictionary_owner_hard 
)

Set the pointer to the dictionary_owner_hard for a DXF OLEFRAME entity.

Parameters:
oleframea pointer to a DXF OLEFRAME entity.
dictionary_owner_harda string containing the pointer to the dictionary_owner_hard for the entity.

Definition at line 1757 of file oleframe.c.

References _, dxf_oleframe_struct::dictionary_owner_hard, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

int16_t dxf_oleframe_get_lineweight ( DxfOleFrame *  oleframe)

Get the lineweight from a DXF OLEFRAME entity.

Returns:
lineweight when successful, or EXIT_FAILURE when an error occurred.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.

Definition at line 1799 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::lineweight.

DxfOleFrame* dxf_oleframe_set_lineweight ( DxfOleFrame *  oleframe,
int16_t  lineweight 
)

Set the lineweight for a DXF OLEFRAME entity.

Returns:
a pointer to oleframe when successful, or NULL when an error occurred.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.
lineweightthe lineweight to be set for the entity.

Definition at line 1830 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::lineweight.

char* dxf_oleframe_get_plot_style_name ( DxfOleFrame *  oleframe)

Get the plot_style_name from a DXF OLEFRAME entity.

Returns:
a pointer to plot_style_name when sucessful, or NULL when an error occurred.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.

Definition at line 1864 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::plot_style_name.

DxfOleFrame* dxf_oleframe_set_plot_style_name ( DxfOleFrame *  oleframe,
char *  plot_style_name 
)

Set the plot_style_name for a DXF OLEFRAME entity.

Returns:
a pointer to oleframe when successful, or NULL when an error occurred.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.
plot_style_namea string containing the plot_style_name for the entity.

Definition at line 1902 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::plot_style_name.

long dxf_oleframe_get_color_value ( DxfOleFrame *  oleframe)

Get the color_value from a DXF OLEFRAME entity.

Returns:
color_value when successful, or EXIT_FAILURE when an error occurred.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.

Definition at line 1944 of file oleframe.c.

References _, dxf_oleframe_struct::color_value, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

DxfOleFrame* dxf_oleframe_set_color_value ( DxfOleFrame *  oleframe,
long  color_value 
)

Set the color_value for a DXF OLEFRAME entity.

Returns:
a pointer to oleframe when successful, or NULL when an error occurred.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.
color_valuethe color_value to be set for the entity.

Definition at line 1975 of file oleframe.c.

References _, dxf_oleframe_struct::color_value, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

char* dxf_oleframe_get_color_name ( DxfOleFrame *  oleframe)

Get the color_name from a DXF OLEFRAME entity.

Returns:
color_name when sucessful, or NULL when an error occurred.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.

Definition at line 2009 of file oleframe.c.

References _, dxf_oleframe_struct::color_name, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

DxfOleFrame* dxf_oleframe_set_color_name ( DxfOleFrame *  oleframe,
char *  color_name 
)

Set the color_name for a DXF OLEFRAME entity.

Returns:
a pointer to oleframe when successful, or NULL when an error occurred.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.
color_namea string containing the color_name for the entity.

Definition at line 2047 of file oleframe.c.

References _, dxf_oleframe_struct::color_name, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

long dxf_oleframe_get_transparency ( DxfOleFrame *  oleframe)

Get the transparency from a DXF OLEFRAME entity.

Returns:
transparency when successful, or EXIT_FAILURE when an error occurred.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.

Definition at line 2089 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::transparency.

DxfOleFrame* dxf_oleframe_set_transparency ( DxfOleFrame *  oleframe,
long  transparency 
)

Set the transparency for a DXF OLEFRAME entity.

Returns:
a pointer to oleframe when successful, or NULL when an error occurred.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.
transparencythe transparency to be set for the entity.

Definition at line 2120 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::transparency.

int dxf_oleframe_get_ole_version_number ( DxfOleFrame *  oleframe)

Get the ole_version_number from a DXF OLEFRAME entity.

Returns:
ole_version_number.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.

Definition at line 2153 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::ole_version_number.

DxfOleFrame* dxf_oleframe_set_ole_version_number ( DxfOleFrame *  oleframe,
int  ole_version_number 
)

Set the ole_version_number for a DXF OLEFRAME entity.

Parameters:
oleframea pointer to a DXF OLEFRAME entity.
ole_version_numberthe ole_version_number for the entity.

Definition at line 2187 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::ole_version_number.

long dxf_oleframe_get_length ( DxfOleFrame *  oleframe)

Get the length from a DXF OLEFRAME entity.

Returns:
length when successful, or EXIT_FAILURE when an error occurred.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.

Definition at line 2227 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::length.

DxfOleFrame* dxf_oleframe_set_length ( DxfOleFrame *  oleframe,
long  length 
)

Set the length for a DXF OLEFRAME entity.

Returns:
a pointer to oleframe when successful, or NULL when an error occurred.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.
lengththe length to be set for the entity.

Definition at line 2258 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::length.

DxfChar* dxf_oleframe_get_binary_data ( DxfOleFrame *  oleframe)

Get the binary_data from a DXF OLEFRAME entity.

Returns:
binary_data when sucessful, or NULL when an error occurred.
Warning:
No deep copy of the returned pointer is made.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.

Definition at line 2294 of file oleframe.c.

References _, dxf_oleframe_struct::binary_data, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

DxfOleFrame* dxf_oleframe_set_binary_data ( DxfOleFrame *  oleframe,
DxfChar *  binary_data 
)

Set the binary_data for a DXF OLEFRAME entity.

Returns:
a pointer to oleframe when successful, or NULL when an error occurred.
Warning:
No deep copy of the passed pointer is made.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.
binary_datathe binary_data for the entity.

Definition at line 2334 of file oleframe.c.

References _, dxf_oleframe_struct::binary_data, DXF_DEBUG_BEGIN, and DXF_DEBUG_END.

DxfOleFrame* dxf_oleframe_get_next ( DxfOleFrame *  oleframe)

Get the pointer to the next OLEFRAME entity from a DXF OLEFRAME entity.

Returns:
pointer to the next OLEFRAME entity.
Warning:
No checks are performed on the returned pointer.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.

Definition at line 2377 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::next.

DxfOleFrame* dxf_oleframe_set_next ( DxfOleFrame *  oleframe,
DxfOleFrame *  next 
)

Set the pointer to the next OLEFRAME for a DXF OLEFRAME entity.

Parameters:
oleframea pointer to a DXF OLEFRAME entity.
nexta pointer to the next OLEFRAME for the entity.

Definition at line 2413 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::next.

DxfOleFrame* dxf_oleframe_get_last ( DxfOleFrame *  oleframe)

Get the pointer to the last OLEFRAME entity from a linked list of DXF OLEFRAME entities.

Returns:
pointer to the last OLEFRAME entity.
Warning:
No checks are performed on the returned pointer.
Parameters:
oleframea pointer to a DXF OLEFRAME entity.

Definition at line 2456 of file oleframe.c.

References _, DXF_DEBUG_BEGIN, DXF_DEBUG_END, and dxf_oleframe_struct::next.

Generated on Sun Nov 19 2017 for libDXF by  doxygen 1.7.3