IDE-Generator Python
Loading...
Searching...
No Matches
ide_gen.xcode.PBXFileReference Class Reference

A PBXFileReference entry. More...

Inheritance diagram for ide_gen.xcode.PBXFileReference:
Collaboration diagram for ide_gen.xcode.PBXFileReference:

Public Member Functions

 __init__ (self, file_name, uuid=None, file_type=None)
 Initialize the PBXFileReference object.
Public Member Functions inherited from ide_gen.xcode_json.JSONDict
 __init__ (self, name, comment=None, value=None, uuid=None, enabled=True, disable_if_empty=False, isa=None, flattened=False)
 Initialize the entry.
 add_dict_entry (self, name, value=None, enabled=True)
 Create a new JSONEntry record and add to the dictionary Take the key value pair and append it to the dictionary.
 generate (self, line_list, indent=0)
 Generate the text lines for this JSON element.
Public Member Functions inherited from ide_gen.xcode_json.JSONShared
 __init__ (self, name, comment=None, value=None, uuid=None, enabled=True)
 Initialize the JSONShared entry.
 add_item (self, item)
 Append an item to the array.
 find_item (self, name)
 Find a named JSON item.
 get_comment_string (self)
 Return the string to generate for a comment.
 get_parent (self)
 Traverse the objects until the parent is found.

Public Attributes

 file_name = file_name
 Filename.
 file_type = file_type
 Xcode filetype.
 file_encoding = self.add_dict_entry("fileEncoding", "4")
 fileEncoding record
 explicit_file_type
 explicitFileType record
 last_known_file_type
 lastKnownFileType record
 include_in_index
 includeInIndex record
 name_entry = self.add_dict_entry("name", basename)
 name record
 path = self.add_dict_entry("path", file_name)
 path record
 source_tree = self.add_dict_entry("sourceTree", "SOURCE_ROOT")
 sourceTree record
Public Attributes inherited from ide_gen.xcode_json.JSONDict
 disable_if_empty = disable_if_empty
 True if output is disabled if the list is empty.
 isa = isa
 "Is a" name
 flattened = flattened
 If True, flatten the child objects.
Public Attributes inherited from ide_gen.xcode_json.JSONShared
 name = name
 Object's name (Can also be the uuid)
 comment = comment
 Optional object's comment field.
 value = value
 Value (Can be None, integer, string, array, or JSON object)
 uuid = uuid
 Optional uuid string.
 enabled = enabled
 If False, disable output of this object.
 parent = None
 Reference to the parent object.

Detailed Description

A PBXFileReference entry.

For each and every file managed by an XCode project, a PBXFileReference object will exist to reference it. Other sections of XCode will use the UUID of this object to act upon the file referenced by this object.

The UUID is used for both PBXGroup for file hierachical display and PBXBuildFile if the file needs to be built with a compiler.

Constructor & Destructor Documentation

◆ __init__()

ide_gen.xcode.PBXFileReference.__init__ ( self,
file_name,
uuid = None,
file_type = None )

Initialize the PBXFileReference object.

Parameters
source_filecore.SourceFile record
ideIDETypes of the ide being built for.

Member Data Documentation

◆ explicit_file_type

ide_gen.xcode.PBXFileReference.explicit_file_type
Initial value:
= self.add_dict_entry(
"explicitFileType", file_type, False)

explicitFileType record

◆ include_in_index

ide_gen.xcode.PBXFileReference.include_in_index
Initial value:
= self.add_dict_entry(
"includeInIndex", "0", False)

includeInIndex record

◆ last_known_file_type

ide_gen.xcode.PBXFileReference.last_known_file_type
Initial value:
= self.add_dict_entry(
"lastKnownFileType", file_type)

lastKnownFileType record